Skip to content

DashPackage

Source code in docs_src/capo_mediapackage/types/dash_package.py
class DashPackage(TypedDict, closed=True):
    ad_triggers: NotRequired["capo_mediapackage.types.ad_triggers.AdTriggers"]
    ads_on_delivery_restrictions: NotRequired[
        "capo_mediapackage.types.ads_on_delivery_restrictions.AdsOnDeliveryRestrictions"
    ]
    encryption: NotRequired["capo_mediapackage.types.dash_encryption.DashEncryption"]
    include_iframe_only_stream: NotRequired[
        "capo_mediapackage.types.__boolean.__boolean"
    ]
    """When enabled, an I-Frame only stream will be included in the output."""
    manifest_layout: NotRequired[
        "capo_mediapackage.types.manifest_layout.ManifestLayout"
    ]
    """Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level. When set to DRM_TOP_LEVEL_COMPACT, content protection elements are placed the MPD level and referenced at the AdaptationSet level."""
    manifest_window_seconds: NotRequired["capo_mediapackage.types.__integer.__integer"]
    """Time window (in seconds) contained in each manifest."""
    min_buffer_time_seconds: NotRequired["capo_mediapackage.types.__integer.__integer"]
    """Minimum duration (in seconds) that a player will buffer media before starting the presentation."""
    min_update_period_seconds: NotRequired[
        "capo_mediapackage.types.__integer.__integer"
    ]
    """Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD)."""
    period_triggers: NotRequired[
        "capo_mediapackage.types.__list_of__period_triggers_element.__listOf__PeriodTriggersElement"
    ]
    """A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers."""
    profile: NotRequired["capo_mediapackage.types.profile.Profile"]
    """The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. When set to "DVB-DASH_2014", DVB-DASH 2014 compliant output is enabled."""
    segment_duration_seconds: NotRequired["capo_mediapackage.types.__integer.__integer"]
    """Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration."""
    segment_template_format: NotRequired[
        "capo_mediapackage.types.segment_template_format.SegmentTemplateFormat"
    ]
    """Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs."""
    stream_selection: NotRequired[
        "capo_mediapackage.types.stream_selection.StreamSelection"
    ]
    suggested_presentation_delay_seconds: NotRequired[
        "capo_mediapackage.types.__integer.__integer"
    ]
    """Duration (in seconds) to delay live content before presentation."""
    utc_timing: NotRequired["capo_mediapackage.types.utc_timing.UtcTiming"]
    """Determines the type of UTCTiming included in the Media Presentation Description (MPD)"""
    utc_timing_uri: NotRequired["capo_mediapackage.types.__string.__string"]
    """Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE"""

ad_triggers instance-attribute

ad_triggers: NotRequired[AdTriggers]

ads_on_delivery_restrictions instance-attribute

ads_on_delivery_restrictions: NotRequired[AdsOnDeliveryRestrictions]

encryption instance-attribute

encryption: NotRequired[DashEncryption]

include_iframe_only_stream instance-attribute

include_iframe_only_stream: NotRequired[__boolean]

When enabled, an I-Frame only stream will be included in the output.

manifest_layout instance-attribute

manifest_layout: NotRequired[ManifestLayout]

Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level. When set to DRM_TOP_LEVEL_COMPACT, content protection elements are placed the MPD level and referenced at the AdaptationSet level.

manifest_window_seconds instance-attribute

manifest_window_seconds: NotRequired[__integer]

Time window (in seconds) contained in each manifest.

min_buffer_time_seconds instance-attribute

min_buffer_time_seconds: NotRequired[__integer]

Minimum duration (in seconds) that a player will buffer media before starting the presentation.

min_update_period_seconds instance-attribute

min_update_period_seconds: NotRequired[__integer]

Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).

period_triggers instance-attribute

period_triggers: NotRequired[__listOf__PeriodTriggersElement]

A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.

profile instance-attribute

profile: NotRequired[Profile]

The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. When set to "DVB-DASH_2014", DVB-DASH 2014 compliant output is enabled.

segment_duration_seconds instance-attribute

segment_duration_seconds: NotRequired[__integer]

Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.

segment_template_format instance-attribute

segment_template_format: NotRequired[SegmentTemplateFormat]

Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with \(Number\) media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with \(Time\) media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with \(Number\) media URLs.

stream_selection instance-attribute

stream_selection: NotRequired[StreamSelection]

suggested_presentation_delay_seconds instance-attribute

suggested_presentation_delay_seconds: NotRequired[__integer]

Duration (in seconds) to delay live content before presentation.

utc_timing instance-attribute

utc_timing: NotRequired[UtcTiming]

Determines the type of UTCTiming included in the Media Presentation Description (MPD)

utc_timing_uri instance-attribute

utc_timing_uri: NotRequired[__string]

Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE