/AWS1/CL_MDLAUDIODESCRIPTION¶
Audio Description
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
IV_AUDIOSELECTORNAME TYPE /AWS1/MDL__STRING /AWS1/MDL__STRING¶
The name of the AudioSelector used as the source for this AudioDescription.
IV_NAME TYPE /AWS1/MDL__STRINGMAX255 /AWS1/MDL__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.
Optional arguments:¶
IO_AUDIONORMALIZATIONSTGS TYPE REF TO /AWS1/CL_MDLAUDIONORMALIZATI00 /AWS1/CL_MDLAUDIONORMALIZATI00¶
Advanced audio normalization settings.
IV_AUDIOTYPE TYPE /AWS1/MDLAUDIOTYPE /AWS1/MDLAUDIOTYPE¶
Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
IV_AUDIOTYPECONTROL TYPE /AWS1/MDLAUDIODESCAUDIOTYPECTL /AWS1/MDLAUDIODESCAUDIOTYPECTL¶
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.
IO_AUDIOWATERMARKINGSETTINGS TYPE REF TO /AWS1/CL_MDLAUDIOWATERMARKSTGS /AWS1/CL_MDLAUDIOWATERMARKSTGS¶
Settings to configure one or more solutions that insert audio watermarks in the audio encode
IO_CODECSETTINGS TYPE REF TO /AWS1/CL_MDLAUDIOCODECSETTINGS /AWS1/CL_MDLAUDIOCODECSETTINGS¶
Audio codec settings.
IV_LANGUAGECODE TYPE /AWS1/MDL__STRINGMIN1MAX35 /AWS1/MDL__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.
IV_LANGUAGECODECONTROL TYPE /AWS1/MDLAUDIODSCLANGUAGECOD00 /AWS1/MDLAUDIODSCLANGUAGECOD00¶
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.
IO_REMIXSETTINGS TYPE REF TO /AWS1/CL_MDLREMIXSETTINGS /AWS1/CL_MDLREMIXSETTINGS¶
Settings that control how input audio channels are remixed into the output audio channels.
IV_STREAMNAME TYPE /AWS1/MDL__STRING /AWS1/MDL__STRING¶
Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
IT_AUDIODASHROLES TYPE /AWS1/CL_MDL__LSTOFDASHROLEA00=>TT___LISTOFDASHROLEAUDIO TT___LISTOFDASHROLEAUDIO¶
Identifies the DASH roles to assign to this audio output. Applies only when the audio output is configured for DVB DASH accessibility signaling.
IV_DVBDASHACCESSIBILITY TYPE /AWS1/MDLDVBDASHACCESSIBILITY /AWS1/MDLDVBDASHACCESSIBILITY¶
Identifies DVB DASH accessibility signaling in this audio output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
Queryable Attributes¶
AudioNormalizationSettings¶
Advanced audio normalization settings.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUDIONORMALIZATIONSTGS() |
Getter for AUDIONORMALIZATIONSETTINGS |
AudioSelectorName¶
The name of the AudioSelector used as the source for this AudioDescription.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUDIOSELECTORNAME() |
Getter for AUDIOSELECTORNAME, with configurable default |
ASK_AUDIOSELECTORNAME() |
Getter for AUDIOSELECTORNAME w/ exceptions if field has no v |
HAS_AUDIOSELECTORNAME() |
Determine if AUDIOSELECTORNAME has a value |
AudioType¶
Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUDIOTYPE() |
Getter for AUDIOTYPE, with configurable default |
ASK_AUDIOTYPE() |
Getter for AUDIOTYPE w/ exceptions if field has no value |
HAS_AUDIOTYPE() |
Determine if AUDIOTYPE has a value |
AudioTypeControl¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUDIOTYPECONTROL() |
Getter for AUDIOTYPECONTROL, with configurable default |
ASK_AUDIOTYPECONTROL() |
Getter for AUDIOTYPECONTROL w/ exceptions if field has no va |
HAS_AUDIOTYPECONTROL() |
Determine if AUDIOTYPECONTROL has a value |
AudioWatermarkingSettings¶
Settings to configure one or more solutions that insert audio watermarks in the audio encode
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUDIOWATERMARKINGSTGS() |
Getter for AUDIOWATERMARKINGSETTINGS |
CodecSettings¶
Audio codec settings.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CODECSETTINGS() |
Getter for CODECSETTINGS |
LanguageCode¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LANGUAGECODE() |
Getter for LANGUAGECODE, with configurable default |
ASK_LANGUAGECODE() |
Getter for LANGUAGECODE w/ exceptions if field has no value |
HAS_LANGUAGECODE() |
Determine if LANGUAGECODE has a value |
LanguageCodeControl¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LANGUAGECODECONTROL() |
Getter for LANGUAGECODECONTROL, with configurable default |
ASK_LANGUAGECODECONTROL() |
Getter for LANGUAGECODECONTROL w/ exceptions if field has no |
HAS_LANGUAGECODECONTROL() |
Determine if LANGUAGECODECONTROL has a value |
Name¶
The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
RemixSettings¶
Settings that control how input audio channels are remixed into the output audio channels.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REMIXSETTINGS() |
Getter for REMIXSETTINGS |
StreamName¶
Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STREAMNAME() |
Getter for STREAMNAME, with configurable default |
ASK_STREAMNAME() |
Getter for STREAMNAME w/ exceptions if field has no value |
HAS_STREAMNAME() |
Determine if STREAMNAME has a value |
AudioDashRoles¶
Identifies the DASH roles to assign to this audio output. Applies only when the audio output is configured for DVB DASH accessibility signaling.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUDIODASHROLES() |
Getter for AUDIODASHROLES, with configurable default |
ASK_AUDIODASHROLES() |
Getter for AUDIODASHROLES w/ exceptions if field has no valu |
HAS_AUDIODASHROLES() |
Determine if AUDIODASHROLES has a value |
DvbDashAccessibility¶
Identifies DVB DASH accessibility signaling in this audio output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DVBDASHACCESSIBILITY() |
Getter for DVBDASHACCESSIBILITY, with configurable default |
ASK_DVBDASHACCESSIBILITY() |
Getter for DVBDASHACCESSIBILITY w/ exceptions if field has n |
HAS_DVBDASHACCESSIBILITY() |
Determine if DVBDASHACCESSIBILITY has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT___LISTOFAUDIODESCRIPTION¶
TYPES TT___LISTOFAUDIODESCRIPTION TYPE STANDARD TABLE OF REF TO /AWS1/CL_MDLAUDIODESCRIPTION WITH DEFAULT KEY
.