Interface Av1Settings.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Av1Settings.Builder,Av1Settings>, SdkBuilder<Av1Settings.Builder,Av1Settings>, SdkPojo
Enclosing class:
Av1Settings
@Mutable @NotThreadSafe public static interface Av1Settings.Builder extends SdkPojo, CopyableBuilder<Av1Settings.Builder,Av1Settings>

  • Method Details

    • afdSignaling

      Av1Settings.Builder afdSignaling(String 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
      Parameters:
      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
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • afdSignaling

      Av1Settings.Builder afdSignaling(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
      Parameters:
      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
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • bufSize

      Av1Settings.Builder bufSize(Integer bufSize)
      The size of the buffer (HRD buffer model) in bits.
      Parameters:
      bufSize - The size of the buffer (HRD buffer model) in bits.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • colorSpaceSettings

      Av1Settings.Builder colorSpaceSettings(Av1ColorSpaceSettings colorSpaceSettings)
      Color Space settings
      Parameters:
      colorSpaceSettings - Color Space settings
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • colorSpaceSettings

      default Av1Settings.Builder colorSpaceSettings(Consumer<Av1ColorSpaceSettings.Builder> colorSpaceSettings)
      Color Space settings This is a convenience method that creates an instance of the Av1ColorSpaceSettings.Builder avoiding the need to create one manually via Av1ColorSpaceSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to colorSpaceSettings(Av1ColorSpaceSettings).

      Parameters:
      colorSpaceSettings - a consumer that will call methods on Av1ColorSpaceSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fixedAfd

      Av1Settings.Builder fixedAfd(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fixedAfd

      Av1Settings.Builder fixedAfd(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • framerateDenominator

      Av1Settings.Builder framerateDenominator(Integer framerateDenominator)
      The denominator for the framerate. Framerate is a fraction, for example, 24000 / 1001.
      Parameters:
      framerateDenominator - The denominator for the framerate. Framerate is a fraction, for example, 24000 / 1001.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • framerateNumerator

      Av1Settings.Builder framerateNumerator(Integer framerateNumerator)
      The numerator for the framerate. Framerate is a fraction, for example, 24000 / 1001.
      Parameters:
      framerateNumerator - The numerator for the framerate. Framerate is a fraction, for example, 24000 / 1001.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gopSize

      Av1Settings.Builder gopSize(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • gopSizeUnits

      Av1Settings.Builder gopSizeUnits(String gopSizeUnits)
      Choose the units for the GOP size: FRAMES or SECONDS. For SECONDS, MediaLive converts the size into a frame count at run time.
      Parameters:
      gopSizeUnits - Choose the units for the GOP size: FRAMES or SECONDS. For SECONDS, MediaLive converts the size into a frame count at run time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • gopSizeUnits

      Av1Settings.Builder gopSizeUnits(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.
      Parameters:
      gopSizeUnits - Choose the units for the GOP size: FRAMES or SECONDS. For SECONDS, MediaLive converts the size into a frame count at run time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • level

      Av1Settings.Builder level(String level)
      Sets the level. This parameter is one of the properties of the encoding scheme for AV1.
      Parameters:
      level - Sets the level. This parameter is one of the properties of the encoding scheme for AV1.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • level

      Av1Settings.Builder level(Av1Level level)
      Sets the level. This parameter is one of the properties of the encoding scheme for AV1.
      Parameters:
      level - Sets the level. This parameter is one of the properties of the encoding scheme for AV1.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lookAheadRateControl

      Av1Settings.Builder lookAheadRateControl(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lookAheadRateControl

      Av1Settings.Builder lookAheadRateControl(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxBitrate

      Av1Settings.Builder maxBitrate(Integer maxBitrate)
      The maximum bitrate to assign. For recommendations, see the description for qvbrQualityLevel.
      Parameters:
      maxBitrate - The maximum bitrate to assign. For recommendations, see the description for qvbrQualityLevel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minIInterval

      Av1Settings.Builder minIInterval(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
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • parDenominator

      Av1Settings.Builder parDenominator(Integer parDenominator)
      The denominator for the output pixel aspect ratio (PAR).
      Parameters:
      parDenominator - The denominator for the output pixel aspect ratio (PAR).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parNumerator

      Av1Settings.Builder parNumerator(Integer parNumerator)
      The numerator for the output pixel aspect ratio (PAR).
      Parameters:
      parNumerator - The numerator for the output pixel aspect ratio (PAR).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • qvbrQualityLevel

      Av1Settings.Builder qvbrQualityLevel(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
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • sceneChangeDetect

      Av1Settings.Builder sceneChangeDetect(String sceneChangeDetect)
      Controls whether MediaLive inserts I-frames when it detects a scene change. ENABLED or DISABLED.
      Parameters:
      sceneChangeDetect - Controls whether MediaLive inserts I-frames when it detects a scene change. ENABLED or DISABLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sceneChangeDetect

      Av1Settings.Builder sceneChangeDetect(Av1SceneChangeDetect sceneChangeDetect)
      Controls whether MediaLive inserts I-frames when it detects a scene change. ENABLED or DISABLED.
      Parameters:
      sceneChangeDetect - Controls whether MediaLive inserts I-frames when it detects a scene change. ENABLED or DISABLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timecodeBurninSettings

      Av1Settings.Builder timecodeBurninSettings(TimecodeBurninSettings timecodeBurninSettings)
      Configures the timecode burn-in feature. If you enable this feature, the timecode will become part of the video.
      Parameters:
      timecodeBurninSettings - Configures the timecode burn-in feature. If you enable this feature, the timecode will become part of the video.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timecodeBurninSettings

      default Av1Settings.Builder timecodeBurninSettings(Consumer<TimecodeBurninSettings.Builder> timecodeBurninSettings)
      Configures the timecode burn-in feature. If you enable this feature, the timecode will become part of the video. This is a convenience method that creates an instance of the TimecodeBurninSettings.Builder avoiding the need to create one manually via TimecodeBurninSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timecodeBurninSettings(TimecodeBurninSettings).

      Parameters:
      timecodeBurninSettings - a consumer that will call methods on TimecodeBurninSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • bitrate

      Av1Settings.Builder bitrate(Integer bitrate)
      Average bitrate in bits/second. Required when the rate control mode is CBR. Not used for QVBR.
      Parameters:
      bitrate - Average bitrate in bits/second. Required when the rate control mode is CBR. Not used for QVBR.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rateControlMode

      Av1Settings.Builder rateControlMode(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rateControlMode

      Av1Settings.Builder rateControlMode(Av1RateControlMode 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: