Skip to content

AudioDescription

Source code in docs_src/capo_medialive/types/audio_description.py
class AudioDescription(TypedDict, closed=True):
    audio_normalization_settings: NotRequired[
        "capo_medialive.types.audio_normalization_settings.AudioNormalizationSettings"
    ]
    """Advanced audio normalization settings."""
    audio_selector_name: NotRequired["capo_medialive.types.__string.__string"]
    """The name of the AudioSelector used as the source for this AudioDescription."""
    audio_type: NotRequired["capo_medialive.types.audio_type.AudioType"]
    """Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1."""
    audio_type_control: NotRequired[
        "capo_medialive.types.audio_description_audio_type_control.AudioDescriptionAudioTypeControl"
    ]
    """Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd."""
    audio_watermarking_settings: NotRequired[
        "capo_medialive.types.audio_watermark_settings.AudioWatermarkSettings"
    ]
    """Settings to configure one or more solutions that insert audio watermarks in the audio encode"""
    codec_settings: NotRequired[
        "capo_medialive.types.audio_codec_settings.AudioCodecSettings"
    ]
    """Audio codec settings."""
    language_code: NotRequired[
        "capo_medialive.types.__string_min1_max35.__stringMin1Max35"
    ]
    """RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input."""
    language_code_control: NotRequired[
        "capo_medialive.types.audio_description_language_code_control.AudioDescriptionLanguageCodeControl"
    ]
    """Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input."""
    name: NotRequired["capo_medialive.types.__string_max255.__stringMax255"]
    """The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event."""
    remix_settings: NotRequired["capo_medialive.types.remix_settings.RemixSettings"]
    """Settings that control how input audio channels are remixed into the output audio channels."""
    stream_name: NotRequired["capo_medialive.types.__string.__string"]
    """Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary)."""
    audio_dash_roles: NotRequired[
        "capo_medialive.types.__list_of_dash_role_audio.__listOfDashRoleAudio"
    ]
    """Identifies the DASH roles to assign to this audio output. Applies only when the audio output is configured for DVB DASH accessibility signaling."""
    dvb_dash_accessibility: NotRequired[
        "capo_medialive.types.dvb_dash_accessibility.DvbDashAccessibility"
    ]
    """Identifies DVB DASH accessibility signaling in this audio output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers."""

audio_dash_roles instance-attribute

audio_dash_roles: NotRequired[__listOfDashRoleAudio]

Identifies the DASH roles to assign to this audio output. Applies only when the audio output is configured for DVB DASH accessibility signaling.

audio_normalization_settings instance-attribute

audio_normalization_settings: NotRequired[AudioNormalizationSettings]

Advanced audio normalization settings.

audio_selector_name instance-attribute

audio_selector_name: NotRequired[__string]

The name of the AudioSelector used as the source for this AudioDescription.

audio_type instance-attribute

audio_type: NotRequired[AudioType]

Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.

audio_type_control instance-attribute

audio_type_control: NotRequired[AudioDescriptionAudioTypeControl]

Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.

audio_watermarking_settings instance-attribute

audio_watermarking_settings: NotRequired[AudioWatermarkSettings]

Settings to configure one or more solutions that insert audio watermarks in the audio encode

codec_settings instance-attribute

codec_settings: NotRequired[AudioCodecSettings]

Audio codec settings.

dvb_dash_accessibility instance-attribute

dvb_dash_accessibility: NotRequired[DvbDashAccessibility]

Identifies DVB DASH accessibility signaling in this audio output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.

language_code instance-attribute

language_code: NotRequired[__stringMin1Max35]

RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.

language_code_control instance-attribute

language_code_control: NotRequired[AudioDescriptionLanguageCodeControl]

Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.

name instance-attribute

name: NotRequired[__stringMax255]

The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.

remix_settings instance-attribute

remix_settings: NotRequired[RemixSettings]

Settings that control how input audio channels are remixed into the output audio channels.

stream_name instance-attribute

stream_name: NotRequired[__string]

Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).