Class Av1Settings

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

  • Method Details

    • afdSignaling

      public final AfdSignaling afdSignaling()
      Configures whether MediaLive will write AFD values into the video. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: the AFD value will be the value configured in the fixedAfd parameter. NONE: MediaLive won't write AFD into the video

      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:
      Configures whether MediaLive will write AFD values into the video. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: the AFD value will be the value configured in the fixedAfd parameter. NONE: MediaLive won't write AFD into the video
      See Also:

    • afdSignalingAsString

      public final String afdSignalingAsString()
      Configures whether MediaLive will write AFD values into the video. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: the AFD value will be the value configured in the fixedAfd parameter. NONE: MediaLive won't write AFD into the video

      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:
      Configures whether MediaLive will write AFD values into the video. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: the AFD value will be the value configured in the fixedAfd parameter. NONE: MediaLive won't write AFD into the video
      See Also:

    • bufSize

      public final Integer bufSize()
      The size of the buffer (HRD buffer model) in bits.
      Returns:
      The size of the buffer (HRD buffer model) in bits.

    • colorSpaceSettings

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

    • fixedAfd

      public final FixedAfd fixedAfd()
      Complete this property only if you set the afdSignaling property to FIXED. Choose the AFD value (4 bits) to write on all frames of the video encode.

      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:
      Complete this property only if you set the afdSignaling property to FIXED. Choose the AFD value (4 bits) to write on all frames of the video encode.
      See Also:

    • fixedAfdAsString

      public final String fixedAfdAsString()
      Complete this property only if you set the afdSignaling property to FIXED. Choose the AFD value (4 bits) to write on all frames of the video encode.

      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:
      Complete this property only if you set the afdSignaling property to FIXED. Choose the AFD value (4 bits) to write on all frames of the video encode.
      See Also:

    • framerateDenominator

      public final Integer framerateDenominator()
      The denominator for the framerate. Framerate is a fraction, for example, 24000 / 1001.
      Returns:
      The denominator for the framerate. Framerate is a fraction, for example, 24000 / 1001.

    • framerateNumerator

      public final Integer framerateNumerator()
      The numerator for the framerate. Framerate is a fraction, for example, 24000 / 1001.
      Returns:
      The numerator for the framerate. Framerate is a fraction, for example, 24000 / 1001.

    • gopSize

      public final Double gopSize()
      The GOP size (keyframe interval). If GopSizeUnits is frames, GopSize must be a whole number and must be greater than or equal to 1. If GopSizeUnits is seconds, GopSize must be greater than 0, but it can be a decimal.
      Returns:
      The GOP size (keyframe interval). If GopSizeUnits is frames, GopSize must be a whole number and must be greater than or equal to 1. If GopSizeUnits is seconds, GopSize must be greater than 0, but it can be a decimal.

    • gopSizeUnits

      public final Av1GopSizeUnits gopSizeUnits()
      Choose the units for the GOP size: FRAMES or SECONDS. For SECONDS, MediaLive converts the size 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 Av1GopSizeUnits.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gopSizeUnitsAsString().

      Returns:
      Choose the units for the GOP size: FRAMES or SECONDS. For SECONDS, MediaLive converts the size into a frame count at run time.
      See Also:

    • gopSizeUnitsAsString

      public final String gopSizeUnitsAsString()
      Choose the units for the GOP size: FRAMES or SECONDS. For SECONDS, MediaLive converts the size 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 Av1GopSizeUnits.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gopSizeUnitsAsString().

      Returns:
      Choose the units for the GOP size: FRAMES or SECONDS. For SECONDS, MediaLive converts the size into a frame count at run time.
      See Also:

    • level

      public final Av1Level level()
      Sets the level. This parameter is one of the properties of the encoding scheme for AV1.

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

      Returns:
      Sets the level. This parameter is one of the properties of the encoding scheme for AV1.
      See Also:

    • levelAsString

      public final String levelAsString()
      Sets the level. This parameter is one of the properties of the encoding scheme for AV1.

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

      Returns:
      Sets the level. This parameter is one of the properties of the encoding scheme for AV1.
      See Also:

    • lookAheadRateControl

      public final Av1LookAheadRateControl lookAheadRateControl()
      Sets the amount of lookahead. A value of LOW can decrease latency and memory usage. A value of 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 Av1LookAheadRateControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lookAheadRateControlAsString().

      Returns:
      Sets the amount of lookahead. A value of LOW can decrease latency and memory usage. A value of HIGH can produce better quality for certain content.
      See Also:

    • lookAheadRateControlAsString

      public final String lookAheadRateControlAsString()
      Sets the amount of lookahead. A value of LOW can decrease latency and memory usage. A value of 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 Av1LookAheadRateControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lookAheadRateControlAsString().

      Returns:
      Sets the amount of lookahead. A value of LOW can decrease latency and memory usage. A value of HIGH can produce better quality for certain content.
      See Also:

    • maxBitrate

      public final Integer maxBitrate()
      The maximum bitrate to assign. For recommendations, see the description for qvbrQualityLevel.
      Returns:
      The maximum bitrate to assign. For recommendations, see the description for qvbrQualityLevel.

    • minIInterval

      public final Integer minIInterval()
      Applies only if you enable SceneChangeDetect. Sets the interval between frames. This property ensures a minimum separation between repeated (cadence) I-frames and any I-frames inserted by scene change detection (SCD frames). Enter a number for the interval, measured in number of frames. If an SCD frame and a cadence frame are closer than the specified number of frames, MediaLive shrinks or stretches the GOP to include the SCD frame. Then normal cadence resumes in the next GOP. For GOP stretch to succeed, you must enable LookAheadRateControl. Note that the maximum GOP stretch = (GOP size) + (Minimum I-interval) - 1
      Returns:
      Applies only if you enable SceneChangeDetect. Sets the interval between frames. This property ensures a minimum separation between repeated (cadence) I-frames and any I-frames inserted by scene change detection (SCD frames). Enter a number for the interval, measured in number of frames. If an SCD frame and a cadence frame are closer than the specified number of frames, MediaLive shrinks or stretches the GOP to include the SCD frame. Then normal cadence resumes in the next GOP. For GOP stretch to succeed, you must enable LookAheadRateControl. Note that the maximum GOP stretch = (GOP size) + (Minimum I-interval) - 1

    • parDenominator

      public final Integer parDenominator()
      The denominator for the output pixel aspect ratio (PAR).
      Returns:
      The denominator for the output pixel aspect ratio (PAR).

    • parNumerator

      public final Integer parNumerator()
      The numerator for the output pixel aspect ratio (PAR).
      Returns:
      The numerator for the output pixel aspect ratio (PAR).

    • qvbrQualityLevel

      public final Integer qvbrQualityLevel()
      Controls the target quality for the video encode. With QVBR rate control mode, the final quality is the target quality, constrained by the maxBitrate. Set values for the qvbrQualityLevel property and maxBitrate property that suit your most important viewing devices. To let MediaLive set the quality level (AUTO mode), leave the qvbrQualityLevel field empty. In this case, MediaLive uses the maximum bitrate, and the quality follows from that: more complex content might have a lower quality. Or set a target quality level and a maximum bitrate. With more complex content, MediaLive will try to achieve the target quality, but it won't exceed the maximum bitrate. With less complex content, This option will use only the bitrate needed to reach the target quality. Recommended values are: Primary screen: qvbrQualityLevel: Leave empty. maxBitrate: 4,000,000 PC or tablet: qvbrQualityLevel: Leave empty. maxBitrate: 1,500,000 to 3,000,000 Smartphone: qvbrQualityLevel: Leave empty. maxBitrate: 1,000,000 to 1,500,000
      Returns:
      Controls the target quality for the video encode. With QVBR rate control mode, the final quality is the target quality, constrained by the maxBitrate. Set values for the qvbrQualityLevel property and maxBitrate property that suit your most important viewing devices. To let MediaLive set the quality level (AUTO mode), leave the qvbrQualityLevel field empty. In this case, MediaLive uses the maximum bitrate, and the quality follows from that: more complex content might have a lower quality. Or set a target quality level and a maximum bitrate. With more complex content, MediaLive will try to achieve the target quality, but it won't exceed the maximum bitrate. With less complex content, This option will use only the bitrate needed to reach the target quality. Recommended values are: Primary screen: qvbrQualityLevel: Leave empty. maxBitrate: 4,000,000 PC or tablet: qvbrQualityLevel: Leave empty. maxBitrate: 1,500,000 to 3,000,000 Smartphone: qvbrQualityLevel: Leave empty. maxBitrate: 1,000,000 to 1,500,000

    • sceneChangeDetect

      public final Av1SceneChangeDetect sceneChangeDetect()
      Controls whether MediaLive inserts I-frames when it detects a scene change. ENABLED or DISABLED.

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

      Returns:
      Controls whether MediaLive inserts I-frames when it detects a scene change. ENABLED or DISABLED.
      See Also:

    • sceneChangeDetectAsString

      public final String sceneChangeDetectAsString()
      Controls whether MediaLive inserts I-frames when it detects a scene change. ENABLED or DISABLED.

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

      Returns:
      Controls whether MediaLive inserts I-frames when it detects a scene change. ENABLED or DISABLED.
      See Also:

    • timecodeBurninSettings

      public final TimecodeBurninSettings timecodeBurninSettings()
      Configures the timecode burn-in feature. If you enable this feature, the timecode will become part of the video.
      Returns:
      Configures the timecode burn-in feature. If you enable this feature, the timecode will become part of the video.

    • toBuilder

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

    • builder

      public static Av1Settings.Builder builder()

    • serializableBuilderClass

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