Skip to content

Av1Settings

Source code in docs_src/capo_medialive/types/av1_settings.py
class Av1Settings(TypedDict, closed=True):
    afd_signaling: NotRequired["capo_medialive.types.afd_signaling.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"""
    buf_size: NotRequired[
        "capo_medialive.types.__integer_min50000_max24000000.__integerMin50000Max24000000"
    ]
    """The size of the buffer (HRD buffer model) in bits."""
    color_space_settings: NotRequired[
        "capo_medialive.types.av1_color_space_settings.Av1ColorSpaceSettings"
    ]
    """Specify the type of color space to apply or choose to pass through. The default is to pass through the color space that is in the source."""
    fixed_afd: NotRequired["capo_medialive.types.fixed_afd.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."""
    framerate_denominator: NotRequired[
        "capo_medialive.types.__integer_min1_max3003.__integerMin1Max3003"
    ]
    """The denominator for the framerate. Framerate is a fraction, for example, 24000 / 1001."""
    framerate_numerator: NotRequired[
        "capo_medialive.types.__integer_min1.__integerMin1"
    ]
    """The numerator for the framerate. Framerate is a fraction, for example, 24000 / 1001."""
    gop_size: NotRequired["capo_medialive.types.__double_min0.__doubleMin0"]
    """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."""
    gop_size_units: NotRequired[
        "capo_medialive.types.av1_gop_size_units.Av1GopSizeUnits"
    ]
    """Choose the units for the GOP size: FRAMES or SECONDS. For SECONDS, MediaLive converts the size into a frame count at run time."""
    level: NotRequired["capo_medialive.types.av1_level.Av1Level"]
    """Sets the level. This parameter is one of the properties of the encoding scheme for AV1."""
    look_ahead_rate_control: NotRequired[
        "capo_medialive.types.av1_look_ahead_rate_control.Av1LookAheadRateControl"
    ]
    """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."""
    max_bitrate: NotRequired[
        "capo_medialive.types.__integer_min50000_max12000000.__integerMin50000Max12000000"
    ]
    """The maximum bitrate to assign. For recommendations, see the description for qvbrQualityLevel."""
    min_i_interval: NotRequired[
        "capo_medialive.types.__integer_min0_max30.__integerMin0Max30"
    ]
    """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"""
    par_denominator: NotRequired["capo_medialive.types.__integer_min1.__integerMin1"]
    """The denominator for the output pixel aspect ratio (PAR)."""
    par_numerator: NotRequired["capo_medialive.types.__integer_min1.__integerMin1"]
    """The numerator for the output pixel aspect ratio (PAR)."""
    qvbr_quality_level: NotRequired[
        "capo_medialive.types.__integer_min1_max10.__integerMin1Max10"
    ]
    """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"""
    scene_change_detect: NotRequired[
        "capo_medialive.types.av1_scene_change_detect.Av1SceneChangeDetect"
    ]
    """Controls whether MediaLive inserts I-frames when it detects a scene change. ENABLED or DISABLED."""
    timecode_burnin_settings: NotRequired[
        "capo_medialive.types.timecode_burnin_settings.TimecodeBurninSettings"
    ]
    """Configures the timecode burn-in feature. If you enable this feature, the timecode will become part of the video."""
    bitrate: NotRequired[
        "capo_medialive.types.__integer_min50000_max12000000.__integerMin50000Max12000000"
    ]
    """Average bitrate in bits/second. Required when the rate control mode is CBR. Not used for QVBR."""
    rate_control_mode: NotRequired[
        "capo_medialive.types.av1_rate_control_mode.Av1RateControlMode"
    ]
    """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."""
    min_bitrate: NotRequired[
        "capo_medialive.types.__integer_min0_max8000000.__integerMin0Max8000000"
    ]
    """Used for QVBR rate control mode only. Optional. Enter a minimum bitrate if you want to keep the output bitrate about a threshold, in order to prevent the downstream system from de-allocating network bandwidth for this output."""
    spatial_aq: NotRequired["capo_medialive.types.av1_spatial_aq.Av1SpatialAq"]
    """Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. Enabled: MediaLive will determine the appropriate level of spatial AQ to apply. Disabled: No spatial AQ. For more information, see the topic about video adaptive quantization in the MediaLive user guide."""
    temporal_aq: NotRequired["capo_medialive.types.av1_temporal_aq.Av1TemporalAq"]
    """Temporal AQ makes adjustments within each frame based on variations in content complexity over time. Enabled: MediaLive will determine the appropriate level of temporal AQ to apply. Disabled: No temporal AQ. For more information, see the topic about video adaptive quantization in the MediaLive user guide."""
    timecode_insertion: NotRequired[
        "capo_medialive.types.av1_timecode_insertion_behavior.Av1TimecodeInsertionBehavior"
    ]
    """Controls how MediaLive inserts timecodes into the video output encode. DISABLED: Do not insert timecodes. METADATA_OBU: Include timecodes. MediaLive inserts timecode metadata based on the timecode from the source specified in the Timecode Config property. The timecode metadata is a metadata OBU (Open Bitstream Unit) of type METADATA_TYPE_TIMECODE, in accordance with https://aomediacodec.github.io/av1-spec/#metadata-timecode-syntax."""
    bit_depth: NotRequired["capo_medialive.types.av1_bit_depth.Av1BitDepth"]
    """Specifies the bit depth for the output encode. Choose a value. Or leave the field empty to use the default, which is 8 bit."""

afd_signaling instance-attribute

afd_signaling: NotRequired[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

bit_depth instance-attribute

bit_depth: NotRequired[Av1BitDepth]

Specifies the bit depth for the output encode. Choose a value. Or leave the field empty to use the default, which is 8 bit.

bitrate instance-attribute

bitrate: NotRequired[__integerMin50000Max12000000]

Average bitrate in bits/second. Required when the rate control mode is CBR. Not used for QVBR.

buf_size instance-attribute

buf_size: NotRequired[__integerMin50000Max24000000]

The size of the buffer (HRD buffer model) in bits.

color_space_settings instance-attribute

color_space_settings: NotRequired[Av1ColorSpaceSettings]

Specify the type of color space to apply or choose to pass through. The default is to pass through the color space that is in the source.

fixed_afd instance-attribute

fixed_afd: NotRequired[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.

framerate_denominator instance-attribute

framerate_denominator: NotRequired[__integerMin1Max3003]

The denominator for the framerate. Framerate is a fraction, for example, 24000 / 1001.

framerate_numerator instance-attribute

framerate_numerator: NotRequired[__integerMin1]

The numerator for the framerate. Framerate is a fraction, for example, 24000 / 1001.

gop_size instance-attribute

gop_size: NotRequired[__doubleMin0]

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.

gop_size_units instance-attribute

gop_size_units: NotRequired[Av1GopSizeUnits]

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

level instance-attribute

level: NotRequired[Av1Level]

Sets the level. This parameter is one of the properties of the encoding scheme for AV1.

look_ahead_rate_control instance-attribute

look_ahead_rate_control: NotRequired[Av1LookAheadRateControl]

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.

max_bitrate instance-attribute

max_bitrate: NotRequired[__integerMin50000Max12000000]

The maximum bitrate to assign. For recommendations, see the description for qvbrQualityLevel.

min_bitrate instance-attribute

min_bitrate: NotRequired[__integerMin0Max8000000]

Used for QVBR rate control mode only. Optional. Enter a minimum bitrate if you want to keep the output bitrate about a threshold, in order to prevent the downstream system from de-allocating network bandwidth for this output.

min_i_interval instance-attribute

min_i_interval: NotRequired[__integerMin0Max30]

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

par_denominator instance-attribute

par_denominator: NotRequired[__integerMin1]

The denominator for the output pixel aspect ratio (PAR).

par_numerator instance-attribute

par_numerator: NotRequired[__integerMin1]

The numerator for the output pixel aspect ratio (PAR).

qvbr_quality_level instance-attribute

qvbr_quality_level: NotRequired[__integerMin1Max10]

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

rate_control_mode instance-attribute

rate_control_mode: NotRequired[Av1RateControlMode]

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.

scene_change_detect instance-attribute

scene_change_detect: NotRequired[Av1SceneChangeDetect]

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

spatial_aq instance-attribute

spatial_aq: NotRequired[Av1SpatialAq]

Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. Enabled: MediaLive will determine the appropriate level of spatial AQ to apply. Disabled: No spatial AQ. For more information, see the topic about video adaptive quantization in the MediaLive user guide.

temporal_aq instance-attribute

temporal_aq: NotRequired[Av1TemporalAq]

Temporal AQ makes adjustments within each frame based on variations in content complexity over time. Enabled: MediaLive will determine the appropriate level of temporal AQ to apply. Disabled: No temporal AQ. For more information, see the topic about video adaptive quantization in the MediaLive user guide.

timecode_burnin_settings instance-attribute

timecode_burnin_settings: NotRequired[TimecodeBurninSettings]

Configures the timecode burn-in feature. If you enable this feature, the timecode will become part of the video.

timecode_insertion instance-attribute

timecode_insertion: NotRequired[Av1TimecodeInsertionBehavior]

Controls how MediaLive inserts timecodes into the video output encode. DISABLED: Do not insert timecodes. METADATA_OBU: Include timecodes. MediaLive inserts timecode metadata based on the timecode from the source specified in the Timecode Config property. The timecode metadata is a metadata OBU (Open Bitstream Unit) of type METADATA_TYPE_TIMECODE, in accordance with https://aomediacodec.github.io/av1-spec/#metadata-timecode-syntax.