/AWS1/CL_MDLCAPTIONDESCRIPTION¶
Caption Description
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
IV_CAPTIONSELECTORNAME TYPE /AWS1/MDL__STRING /AWS1/MDL__STRING¶
Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
IV_NAME TYPE /AWS1/MDL__STRING /AWS1/MDL__STRING¶
Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
Optional arguments:¶
IV_ACCESSIBILITY TYPE /AWS1/MDLACCESSIBILITYTYPE /AWS1/MDLACCESSIBILITYTYPE¶
Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.
IO_DESTINATIONSETTINGS TYPE REF TO /AWS1/CL_MDLCAPTIONDSTSETTINGS /AWS1/CL_MDLCAPTIONDSTSETTINGS¶
Additional settings for captions destination that depend on the destination type.
IV_LANGUAGECODE TYPE /AWS1/MDL__STRING /AWS1/MDL__STRING¶
ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
IV_LANGUAGEDESCRIPTION TYPE /AWS1/MDL__STRING /AWS1/MDL__STRING¶
Human readable information to indicate captions available for players (eg. English, or Spanish).
IT_CAPTIONDASHROLES TYPE /AWS1/CL_MDL__LSTOFDASHROLEC00=>TT___LISTOFDASHROLECAPTION TT___LISTOFDASHROLECAPTION¶
Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.
IV_DVBDASHACCESSIBILITY TYPE /AWS1/MDLDVBDASHACCESSIBILITY /AWS1/MDLDVBDASHACCESSIBILITY¶
Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
Queryable Attributes¶
Accessibility¶
Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACCESSIBILITY() |
Getter for ACCESSIBILITY, with configurable default |
ASK_ACCESSIBILITY() |
Getter for ACCESSIBILITY w/ exceptions if field has no value |
HAS_ACCESSIBILITY() |
Determine if ACCESSIBILITY has a value |
CaptionSelectorName¶
Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CAPTIONSELECTORNAME() |
Getter for CAPTIONSELECTORNAME, with configurable default |
ASK_CAPTIONSELECTORNAME() |
Getter for CAPTIONSELECTORNAME w/ exceptions if field has no |
HAS_CAPTIONSELECTORNAME() |
Determine if CAPTIONSELECTORNAME has a value |
DestinationSettings¶
Additional settings for captions destination that depend on the destination type.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESTINATIONSETTINGS() |
Getter for DESTINATIONSETTINGS |
LanguageCode¶
ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
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 |
LanguageDescription¶
Human readable information to indicate captions available for players (eg. English, or Spanish).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LANGUAGEDESCRIPTION() |
Getter for LANGUAGEDESCRIPTION, with configurable default |
ASK_LANGUAGEDESCRIPTION() |
Getter for LANGUAGEDESCRIPTION w/ exceptions if field has no |
HAS_LANGUAGEDESCRIPTION() |
Determine if LANGUAGEDESCRIPTION has a value |
Name¶
Name of the caption description. Used to associate a caption description with an output. Names must be unique within an 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 |
CaptionDashRoles¶
Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CAPTIONDASHROLES() |
Getter for CAPTIONDASHROLES, with configurable default |
ASK_CAPTIONDASHROLES() |
Getter for CAPTIONDASHROLES w/ exceptions if field has no va |
HAS_CAPTIONDASHROLES() |
Determine if CAPTIONDASHROLES has a value |
DvbDashAccessibility¶
Identifies DVB DASH accessibility signaling in this captions 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___LISTOFCAPTIONDESCRIPTION¶
TYPES TT___LISTOFCAPTIONDESCRIPTION TYPE STANDARD TABLE OF REF TO /AWS1/CL_MDLCAPTIONDESCRIPTION WITH DEFAULT KEY
.