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

Class H265Settings

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

  • Method Details

    • adaptiveQuantization

      public final H265AdaptiveQuantization adaptiveQuantization()
      Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.

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

      Returns:
      Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
      See Also:

    • adaptiveQuantizationAsString

      public final String adaptiveQuantizationAsString()
      Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.

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

      Returns:
      Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
      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:

    • alternativeTransferFunction

      public final H265AlternativeTransferFunction alternativeTransferFunction()
      Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.

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

      Returns:
      Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.
      See Also:

    • alternativeTransferFunctionAsString

      public final String alternativeTransferFunctionAsString()
      Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.

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

      Returns:
      Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.
      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.

    • 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 H265ColorMetadata 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 H265ColorMetadata.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 H265ColorMetadata.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 H265ColorSpaceSettings colorSpaceSettings()
      Color Space settings
      Returns:
      Color Space settings

    • filterSettings

      public final H265FilterSettings filterSettings()
      Optional filters that you can apply to an encode.
      Returns:
      Optional filters that you can apply to an encode.

    • 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 H265FlickerAq flickerAq()
      If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.

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

      Returns:
      If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
      See Also:

    • flickerAqAsString

      public final String flickerAqAsString()
      If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.

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

      Returns:
      If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
      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.

    • 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.

    • 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 H265GopSizeUnits 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 H265GopSizeUnits.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 H265GopSizeUnits.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 H265Level level()
      H.265 Level.

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

      Returns:
      H.265 Level.
      See Also:

    • levelAsString

      public final String levelAsString()
      H.265 Level.

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

      Returns:
      H.265 Level.
      See Also:

    • lookAheadRateControl

      public final H265LookAheadRateControl 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 H265LookAheadRateControl.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 H265LookAheadRateControl.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
      Returns:
      For QVBR: See the tooltip for Quality level

    • 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

    • 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 H265Profile profile()
      H.265 Profile.

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

      Returns:
      H.265 Profile.
      See Also:

    • profileAsString

      public final String profileAsString()
      H.265 Profile.

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

      Returns:
      H.265 Profile.
      See Also:

    • qvbrQualityLevel

      public final Integer qvbrQualityLevel()
      Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field 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
      Returns:
      Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field 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

    • rateControlMode

      public final H265RateControlMode 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. 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 H265RateControlMode.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. 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. 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 H265RateControlMode.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. 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 H265ScanType 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 H265ScanType.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 H265ScanType.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 H265SceneChangeDetect sceneChangeDetect()
      Scene change detection.

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

      Returns:
      Scene change detection.
      See Also:

    • sceneChangeDetectAsString

      public final String sceneChangeDetectAsString()
      Scene change detection.

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

      Returns:
      Scene change detection.
      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.

    • tier

      public final H265Tier tier()
      H.265 Tier.

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

      Returns:
      H.265 Tier.
      See Also:

    • tierAsString

      public final String tierAsString()
      H.265 Tier.

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

      Returns:
      H.265 Tier.
      See Also:

    • timecodeInsertion

      public final H265TimecodeInsertionBehavior 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 H265TimecodeInsertionBehavior.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 H265TimecodeInsertionBehavior.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 H265Settings.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<H265Settings.Builder,H265Settings>
      Returns:
      a builder for type T

    • builder

      public static H265Settings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends H265Settings.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.