Skip to content

CaptionDescription

Source code in docs_src/capo_medialive/types/caption_description.py
class CaptionDescription(TypedDict, closed=True):
    accessibility: NotRequired[
        "capo_medialive.types.accessibility_type.AccessibilityType"
    ]
    """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."""
    caption_selector_name: NotRequired["capo_medialive.types.__string.__string"]
    """Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name."""
    destination_settings: NotRequired[
        "capo_medialive.types.caption_destination_settings.CaptionDestinationSettings"
    ]
    """Additional settings for captions destination that depend on the destination type."""
    language_code: NotRequired["capo_medialive.types.__string.__string"]
    """ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/"""
    language_description: NotRequired["capo_medialive.types.__string.__string"]
    """Human readable information to indicate captions available for players (eg. English, or Spanish)."""
    name: NotRequired["capo_medialive.types.__string.__string"]
    """Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event."""
    caption_dash_roles: NotRequired[
        "capo_medialive.types.__list_of_dash_role_caption.__listOfDashRoleCaption"
    ]
    """Identifies the DASH roles to assign to this captions output. Applies only when the captions 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 captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers."""

accessibility instance-attribute

accessibility: NotRequired[AccessibilityType]

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.

caption_dash_roles instance-attribute

caption_dash_roles: NotRequired[__listOfDashRoleCaption]

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

caption_selector_name instance-attribute

caption_selector_name: NotRequired[__string]

Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

destination_settings instance-attribute

destination_settings: NotRequired[CaptionDestinationSettings]

Additional settings for captions destination that depend on the destination type.

dvb_dash_accessibility instance-attribute

dvb_dash_accessibility: NotRequired[DvbDashAccessibility]

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

language_code instance-attribute

language_code: NotRequired[__string]

ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

language_description instance-attribute

language_description: NotRequired[__string]

Human readable information to indicate captions available for players (eg. English, or Spanish).

name instance-attribute

name: NotRequired[__string]

Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.