Package software.amazon.awssdk.services.medialive.model

Class H264Settings

java.lang.Object
software.amazon.awssdk.services.medialive.model.H264Settings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<H264Settings.Builder,H264Settings>
@Generated("software.amazon.awssdk:codegen") public final class H264Settings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<H264Settings.Builder,H264Settings>
H264 Settings
See Also:

  • Method Details

    • adaptiveQuantization

      public final H264AdaptiveQuantization adaptiveQuantization()
      Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization.

      If the service returns an enum value that is not available in the current SDK version, adaptiveQuantization will return H264AdaptiveQuantization.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from adaptiveQuantizationAsString().

      Returns:
      Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization.
      See Also:

    • adaptiveQuantizationAsString

      public final String adaptiveQuantizationAsString()
      Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization.

      If the service returns an enum value that is not available in the current SDK version, adaptiveQuantization will return H264AdaptiveQuantization.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from adaptiveQuantizationAsString().

      Returns:
      Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization.
      See Also:

    • afdSignaling

      public final AfdSignaling afdSignaling()
      Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.

      If the service returns an enum value that is not available in the current SDK version, afdSignaling will return AfdSignaling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from afdSignalingAsString().

      Returns:
      Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
      See Also:

    • afdSignalingAsString

      public final String afdSignalingAsString()
      Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.

      If the service returns an enum value that is not available in the current SDK version, afdSignaling will return AfdSignaling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from afdSignalingAsString().

      Returns:
      Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
      See Also:

    • bitrate

      public final Integer bitrate()
      Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
      Returns:
      Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.

    • bufFillPct

      public final Integer bufFillPct()
      Percentage of the buffer that should initially be filled (HRD buffer model).
      Returns:
      Percentage of the buffer that should initially be filled (HRD buffer model).

    • bufSize

      public final Integer bufSize()
      Size of buffer (HRD buffer model) in bits.
      Returns:
      Size of buffer (HRD buffer model) in bits.

    • colorMetadata

      public final H264ColorMetadata colorMetadata()
      Includes colorspace metadata in the output.

      If the service returns an enum value that is not available in the current SDK version, colorMetadata will return H264ColorMetadata.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from colorMetadataAsString().

      Returns:
      Includes colorspace metadata in the output.
      See Also:

    • colorMetadataAsString

      public final String colorMetadataAsString()
      Includes colorspace metadata in the output.

      If the service returns an enum value that is not available in the current SDK version, colorMetadata will return H264ColorMetadata.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from colorMetadataAsString().

      Returns:
      Includes colorspace metadata in the output.
      See Also:

    • colorSpaceSettings

      public final H264ColorSpaceSettings colorSpaceSettings()
      Color Space settings
      Returns:
      Color Space settings

    • entropyEncoding

      public final H264EntropyEncoding entropyEncoding()
      Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.

      If the service returns an enum value that is not available in the current SDK version, entropyEncoding will return H264EntropyEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from entropyEncodingAsString().

      Returns:
      Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.
      See Also:

    • entropyEncodingAsString

      public final String entropyEncodingAsString()
      Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.

      If the service returns an enum value that is not available in the current SDK version, entropyEncoding will return H264EntropyEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from entropyEncodingAsString().

      Returns:
      Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.
      See Also:

    • filterSettings

      public final H264FilterSettings filterSettings()
      Optional. Both filters reduce bandwidth by removing imperceptible details. You can enable one of the filters. We recommend that you try both filters and observe the results to decide which one to use. The Temporal Filter reduces bandwidth by removing imperceptible details in the content. It combines perceptual filtering and motion compensated temporal filtering (MCTF). It operates independently of the compression level. The Bandwidth Reduction filter is a perceptual filter located within the encoding loop. It adapts to the current compression level to filter imperceptible signals. This filter works only when the resolution is 1080p or lower.
      Returns:
      Optional. Both filters reduce bandwidth by removing imperceptible details. You can enable one of the filters. We recommend that you try both filters and observe the results to decide which one to use. The Temporal Filter reduces bandwidth by removing imperceptible details in the content. It combines perceptual filtering and motion compensated temporal filtering (MCTF). It operates independently of the compression level. The Bandwidth Reduction filter is a perceptual filter located within the encoding loop. It adapts to the current compression level to filter imperceptible signals. This filter works only when the resolution is 1080p or lower.

    • fixedAfd

      public final FixedAfd fixedAfd()
      Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.

      If the service returns an enum value that is not available in the current SDK version, fixedAfd will return FixedAfd.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fixedAfdAsString().

      Returns:
      Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
      See Also:

    • fixedAfdAsString

      public final String fixedAfdAsString()
      Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.

      If the service returns an enum value that is not available in the current SDK version, fixedAfd will return FixedAfd.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fixedAfdAsString().

      Returns:
      Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
      See Also:

    • flickerAq

      public final H264FlickerAq flickerAq()
      Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ.

      If the service returns an enum value that is not available in the current SDK version, flickerAq will return H264FlickerAq.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from flickerAqAsString().

      Returns:
      Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ.
      See Also:

    • flickerAqAsString

      public final String flickerAqAsString()
      Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ.

      If the service returns an enum value that is not available in the current SDK version, flickerAq will return H264FlickerAq.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from flickerAqAsString().

      Returns:
      Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ.
      See Also:

    • forceFieldPictures

      public final H264ForceFieldPictures forceFieldPictures()
      This setting applies only when scan type is "interlaced." It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.) enabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately. disabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content.

      If the service returns an enum value that is not available in the current SDK version, forceFieldPictures will return H264ForceFieldPictures.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from forceFieldPicturesAsString().

      Returns:
      This setting applies only when scan type is "interlaced." It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.) enabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately. disabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content.
      See Also:

    • forceFieldPicturesAsString

      public final String forceFieldPicturesAsString()
      This setting applies only when scan type is "interlaced." It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.) enabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately. disabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content.

      If the service returns an enum value that is not available in the current SDK version, forceFieldPictures will return H264ForceFieldPictures.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from forceFieldPicturesAsString().

      Returns:
      This setting applies only when scan type is "interlaced." It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.) enabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately. disabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content.
      See Also:

    • framerateControl

      public final H264FramerateControl framerateControl()
      This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.

      If the service returns an enum value that is not available in the current SDK version, framerateControl will return H264FramerateControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from framerateControlAsString().

      Returns:
      This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.
      See Also:

    • framerateControlAsString

      public final String framerateControlAsString()
      This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.

      If the service returns an enum value that is not available in the current SDK version, framerateControl will return H264FramerateControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from framerateControlAsString().

      Returns:
      This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.
      See Also:

    • framerateDenominator

      public final Integer framerateDenominator()
      Framerate denominator.
      Returns:
      Framerate denominator.

    • framerateNumerator

      public final Integer framerateNumerator()
      Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
      Returns:
      Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.

    • gopBReference

      public final H264GopBReference gopBReference()
      Documentation update needed

      If the service returns an enum value that is not available in the current SDK version, gopBReference will return H264GopBReference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gopBReferenceAsString().

      Returns:
      Documentation update needed
      See Also:

    • gopBReferenceAsString

      public final String gopBReferenceAsString()
      Documentation update needed

      If the service returns an enum value that is not available in the current SDK version, gopBReference will return H264GopBReference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gopBReferenceAsString().

      Returns:
      Documentation update needed
      See Also:

    • gopClosedCadence

      public final Integer gopClosedCadence()
      Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
      Returns:
      Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.

    • gopNumBFrames

      public final Integer gopNumBFrames()
      Number of B-frames between reference frames.
      Returns:
      Number of B-frames between reference frames.

    • gopSize

      public final Double gopSize()
      GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
      Returns:
      GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.

    • gopSizeUnits

      public final H264GopSizeUnits gopSizeUnits()
      Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.

      If the service returns an enum value that is not available in the current SDK version, gopSizeUnits will return H264GopSizeUnits.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gopSizeUnitsAsString().

      Returns:
      Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
      See Also:

    • gopSizeUnitsAsString

      public final String gopSizeUnitsAsString()
      Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.

      If the service returns an enum value that is not available in the current SDK version, gopSizeUnits will return H264GopSizeUnits.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gopSizeUnitsAsString().

      Returns:
      Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
      See Also:

    • level

      public final H264Level level()
      H.264 Level.

      If the service returns an enum value that is not available in the current SDK version, level will return H264Level.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from levelAsString().

      Returns:
      H.264 Level.
      See Also:

    • levelAsString

      public final String levelAsString()
      H.264 Level.

      If the service returns an enum value that is not available in the current SDK version, level will return H264Level.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from levelAsString().

      Returns:
      H.264 Level.
      See Also:

    • lookAheadRateControl

      public final H264LookAheadRateControl lookAheadRateControl()
      Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.

      If the service returns an enum value that is not available in the current SDK version, lookAheadRateControl will return H264LookAheadRateControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lookAheadRateControlAsString().

      Returns:
      Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
      See Also:

    • lookAheadRateControlAsString

      public final String lookAheadRateControlAsString()
      Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.

      If the service returns an enum value that is not available in the current SDK version, lookAheadRateControl will return H264LookAheadRateControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lookAheadRateControlAsString().

      Returns:
      Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
      See Also:

    • maxBitrate

      public final Integer maxBitrate()
      For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
      Returns:
      For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.

    • minIInterval

      public final Integer minIInterval()
      Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
      Returns:
      Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1

    • numRefFrames

      public final Integer numRefFrames()
      Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
      Returns:
      Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.

    • parControl

      public final H264ParControl parControl()
      This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.

      If the service returns an enum value that is not available in the current SDK version, parControl will return H264ParControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parControlAsString().

      Returns:
      This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.
      See Also:

    • parControlAsString

      public final String parControlAsString()
      This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.

      If the service returns an enum value that is not available in the current SDK version, parControl will return H264ParControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parControlAsString().

      Returns:
      This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.
      See Also:

    • parDenominator

      public final Integer parDenominator()
      Pixel Aspect Ratio denominator.
      Returns:
      Pixel Aspect Ratio denominator.

    • parNumerator

      public final Integer parNumerator()
      Pixel Aspect Ratio numerator.
      Returns:
      Pixel Aspect Ratio numerator.

    • profile

      public final H264Profile profile()
      H.264 Profile.

      If the service returns an enum value that is not available in the current SDK version, profile will return H264Profile.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from profileAsString().

      Returns:
      H.264 Profile.
      See Also:

    • profileAsString

      public final String profileAsString()
      H.264 Profile.

      If the service returns an enum value that is not available in the current SDK version, profile will return H264Profile.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from profileAsString().

      Returns:
      H.264 Profile.
      See Also:

    • qualityLevel

      public final H264QualityLevel qualityLevel()
      Leave as STANDARD_QUALITY or choose a different value (which might result in additional costs to run the channel). - ENHANCED_QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED_QUALITY. - STANDARD_QUALITY: Valid for any Rate control mode.

      If the service returns an enum value that is not available in the current SDK version, qualityLevel will return H264QualityLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from qualityLevelAsString().

      Returns:
      Leave as STANDARD_QUALITY or choose a different value (which might result in additional costs to run the channel). - ENHANCED_QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED_QUALITY. - STANDARD_QUALITY: Valid for any Rate control mode.
      See Also:

    • qualityLevelAsString

      public final String qualityLevelAsString()
      Leave as STANDARD_QUALITY or choose a different value (which might result in additional costs to run the channel). - ENHANCED_QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED_QUALITY. - STANDARD_QUALITY: Valid for any Rate control mode.

      If the service returns an enum value that is not available in the current SDK version, qualityLevel will return H264QualityLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from qualityLevelAsString().

      Returns:
      Leave as STANDARD_QUALITY or choose a different value (which might result in additional costs to run the channel). - ENHANCED_QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED_QUALITY. - STANDARD_QUALITY: Valid for any Rate control mode.
      See Also:

    • qvbrQualityLevel

      public final Integer qvbrQualityLevel()
      Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. You can set a target quality or you can let MediaLive determine the best quality. To set a target quality, enter values in the QVBR quality level field and the Max bitrate field. Enter values that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M To let MediaLive decide, leave the QVBR quality level field empty, and in Max bitrate enter the maximum rate you want in the video. For more information, see the section called "Video - rate control mode" in the MediaLive user guide
      Returns:
      Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. You can set a target quality or you can let MediaLive determine the best quality. To set a target quality, enter values in the QVBR quality level field and the Max bitrate field. Enter values that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M To let MediaLive decide, leave the QVBR quality level field empty, and in Max bitrate enter the maximum rate you want in the video. For more information, see the section called "Video - rate control mode" in the MediaLive user guide

    • rateControlMode

      public final H264RateControlMode rateControlMode()
      Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program.

      If the service returns an enum value that is not available in the current SDK version, rateControlMode will return H264RateControlMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rateControlModeAsString().

      Returns:
      Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program.
      See Also:

    • rateControlModeAsString

      public final String rateControlModeAsString()
      Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program.

      If the service returns an enum value that is not available in the current SDK version, rateControlMode will return H264RateControlMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rateControlModeAsString().

      Returns:
      Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program.
      See Also:

    • scanType

      public final H264ScanType scanType()
      Sets the scan type of the output to progressive or top-field-first interlaced.

      If the service returns an enum value that is not available in the current SDK version, scanType will return H264ScanType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scanTypeAsString().

      Returns:
      Sets the scan type of the output to progressive or top-field-first interlaced.
      See Also:

    • scanTypeAsString

      public final String scanTypeAsString()
      Sets the scan type of the output to progressive or top-field-first interlaced.

      If the service returns an enum value that is not available in the current SDK version, scanType will return H264ScanType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scanTypeAsString().

      Returns:
      Sets the scan type of the output to progressive or top-field-first interlaced.
      See Also:

    • sceneChangeDetect

      public final H264SceneChangeDetect sceneChangeDetect()
      Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected.

      If the service returns an enum value that is not available in the current SDK version, sceneChangeDetect will return H264SceneChangeDetect.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sceneChangeDetectAsString().

      Returns:
      Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected.
      See Also:

    • sceneChangeDetectAsString

      public final String sceneChangeDetectAsString()
      Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected.

      If the service returns an enum value that is not available in the current SDK version, sceneChangeDetect will return H264SceneChangeDetect.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sceneChangeDetectAsString().

      Returns:
      Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected.
      See Also:

    • slices

      public final Integer slices()
      Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
      Returns:
      Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.

    • softness

      public final Integer softness()
      Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. If not set to zero, must be greater than 15.
      Returns:
      Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. If not set to zero, must be greater than 15.

    • spatialAq

      public final H264SpatialAq spatialAq()
      Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ.

      If the service returns an enum value that is not available in the current SDK version, spatialAq will return H264SpatialAq.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from spatialAqAsString().

      Returns:
      Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ.
      See Also:

    • spatialAqAsString

      public final String spatialAqAsString()
      Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ.

      If the service returns an enum value that is not available in the current SDK version, spatialAq will return H264SpatialAq.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from spatialAqAsString().

      Returns:
      Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ.
      See Also:

    • subgopLength

      public final H264SubGopLength subgopLength()
      If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.

      If the service returns an enum value that is not available in the current SDK version, subgopLength will return H264SubGopLength.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subgopLengthAsString().

      Returns:
      If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.
      See Also:

    • subgopLengthAsString

      public final String subgopLengthAsString()
      If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.

      If the service returns an enum value that is not available in the current SDK version, subgopLength will return H264SubGopLength.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subgopLengthAsString().

      Returns:
      If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.
      See Also:

    • syntax

      public final H264Syntax syntax()
      Produces a bitstream compliant with SMPTE RP-2027.

      If the service returns an enum value that is not available in the current SDK version, syntax will return H264Syntax.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from syntaxAsString().

      Returns:
      Produces a bitstream compliant with SMPTE RP-2027.
      See Also:

    • syntaxAsString

      public final String syntaxAsString()
      Produces a bitstream compliant with SMPTE RP-2027.

      If the service returns an enum value that is not available in the current SDK version, syntax will return H264Syntax.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from syntaxAsString().

      Returns:
      Produces a bitstream compliant with SMPTE RP-2027.
      See Also:

    • temporalAq

      public final H264TemporalAq temporalAq()
      Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ.

      If the service returns an enum value that is not available in the current SDK version, temporalAq will return H264TemporalAq.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from temporalAqAsString().

      Returns:
      Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ.
      See Also:

    • temporalAqAsString

      public final String temporalAqAsString()
      Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ.

      If the service returns an enum value that is not available in the current SDK version, temporalAq will return H264TemporalAq.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from temporalAqAsString().

      Returns:
      Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ.
      See Also:

    • timecodeInsertion

      public final H264TimecodeInsertionBehavior timecodeInsertion()
      Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config

      If the service returns an enum value that is not available in the current SDK version, timecodeInsertion will return H264TimecodeInsertionBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timecodeInsertionAsString().

      Returns:
      Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
      See Also:

    • timecodeInsertionAsString

      public final String timecodeInsertionAsString()
      Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config

      If the service returns an enum value that is not available in the current SDK version, timecodeInsertion will return H264TimecodeInsertionBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timecodeInsertionAsString().

      Returns:
      Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
      See Also:

    • timecodeBurninSettings

      public final TimecodeBurninSettings timecodeBurninSettings()
      Timecode burn-in settings
      Returns:
      Timecode burn-in settings

    • toBuilder

      public H264Settings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<H264Settings.Builder,H264Settings>
      Returns:
      a builder for type T

    • builder

      public static H264Settings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends H264Settings.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.