Skip to content

GetDashManifestConfiguration

Source code in docs_src/capo_mediapackagev2/types/get_dash_manifest_configuration.py
class GetDashManifestConfiguration(TypedDict, closed=True):
    manifest_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<p>A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. </p>"""
    url: "str"
    """<p>The egress domain URL for stream delivery from MediaPackage.</p>"""
    manifest_window_seconds: NotRequired["int"]
    """<p>The total duration (in seconds) of the manifest's content.</p>"""
    filter_configuration: NotRequired[
        "capo_mediapackagev2.types.filter_configuration.FilterConfiguration"
    ]
    min_update_period_seconds: NotRequired["int"]
    """<p>Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.</p>"""
    min_buffer_time_seconds: NotRequired["int"]
    """<p>Minimum amount of content (in seconds) that a player must keep available in the buffer.</p>"""
    suggested_presentation_delay_seconds: NotRequired["int"]
    """<p>The amount of time (in seconds) that the player should be from the end of the manifest.</p>"""
    segment_template_format: NotRequired[
        "capo_mediapackagev2.types.dash_segment_template_format.DashSegmentTemplateFormat"
    ]
    """<p>Determines the type of variable used in the <code>media</code> URL of the <code>SegmentTemplate</code> tag in the manifest. Also specifies if segment timeline information is included in <code>SegmentTimeline</code> or <code>SegmentTemplate</code>.</p> <p>Value description:</p> <ul> <li> <p> <code>NUMBER_WITH_TIMELINE</code> - The <code>$Number$</code> variable is used in the <code>media</code> URL. The value of this variable is the sequential number of the segment. A full <code>SegmentTimeline</code> object is presented in each <code>SegmentTemplate</code>.</p> </li> </ul>"""
    period_triggers: NotRequired[
        "capo_mediapackagev2.types.dash_period_triggers.DashPeriodTriggers"
    ]
    """<p>A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see <a href="https://docs.aws.amazon.com/mediapackage/latest/userguide/multi-period.html">Multi-period DASH in AWS Elemental MediaPackage</a>.</p>"""
    scte_dash: NotRequired["capo_mediapackagev2.types.scte_dash.ScteDash"]
    """<p>The SCTE configuration.</p>"""
    drm_signaling: NotRequired[
        "capo_mediapackagev2.types.dash_drm_signaling.DashDrmSignaling"
    ]
    """<p>Determines how the DASH manifest signals the DRM content.</p>"""
    utc_timing: NotRequired["capo_mediapackagev2.types.dash_utc_timing.DashUtcTiming"]
    """<p>Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).</p>"""
    profiles: NotRequired["capo_mediapackagev2.types.dash_profiles.DashProfiles"]
    """<p>The profile that the output is compliant with.</p>"""
    base_urls: NotRequired["capo_mediapackagev2.types.dash_base_urls.DashBaseUrls"]
    """<p>The base URL to use for retrieving segments.</p>"""
    program_information: NotRequired[
        "capo_mediapackagev2.types.dash_program_information.DashProgramInformation"
    ]
    """<p>Details about the content that you want MediaPackage to pass through in the manifest to the playback device.</p>"""
    dvb_settings: NotRequired[
        "capo_mediapackagev2.types.dash_dvb_settings.DashDvbSettings"
    ]
    """<p>For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.</p>"""
    compactness: NotRequired[
        "capo_mediapackagev2.types.dash_compactness.DashCompactness"
    ]
    """<p>The layout of the DASH manifest that MediaPackage produces. <code>STANDARD</code> indicates a default manifest, which is compacted. <code>NONE</code> indicates a full manifest.</p>"""
    audio_timeline_pattern: NotRequired[
        "capo_mediapackagev2.types.dash_audio_timeline_pattern.DashAudioTimelinePattern"
    ]
    """<p>How MediaPackage represents the audio timeline in the DASH manifest, using DASH Segment Duration Patternization for audio adaptation sets. <code>PATTERNED</code> indicates that MediaPackage uses a pattern-based segment template for audio, reducing manifest size. <code>NONE</code> indicates that the manifest contains an explicit timeline for each audio segment.</p>"""
    subtitle_configuration: NotRequired[
        "capo_mediapackagev2.types.dash_subtitle_configuration.DashSubtitleConfiguration"
    ]
    """<p>The configuration for DASH subtitles.</p>"""
    uri_path_type: NotRequired["capo_mediapackagev2.types.uri_path_type.UriPathType"]
    """<p>The type of path used in manifest URIs. <code>LEAF</code> indicates leaf-relative paths. <code>ROOT</code> indicates root-relative paths that include the full path from root.</p>"""
    availability_start_time_configuration: NotRequired[
        "capo_mediapackagev2.types.dash_availability_start_time_configuration.DashAvailabilityStartTimeConfiguration"
    ]
    """<p>The configuration for the DASH <code>availabilityStartTime</code> attribute of the Media Presentation Description (MPD).</p>"""

audio_timeline_pattern instance-attribute

audio_timeline_pattern: NotRequired[DashAudioTimelinePattern]

How MediaPackage represents the audio timeline in the DASH manifest, using DASH Segment Duration Patternization for audio adaptation sets. PATTERNED indicates that MediaPackage uses a pattern-based segment template for audio, reducing manifest size. NONE indicates that the manifest contains an explicit timeline for each audio segment.

availability_start_time_configuration instance-attribute

availability_start_time_configuration: NotRequired[
    DashAvailabilityStartTimeConfiguration
]

The configuration for the DASH availabilityStartTime attribute of the Media Presentation Description (MPD).

base_urls instance-attribute

base_urls: NotRequired[DashBaseUrls]

The base URL to use for retrieving segments.

compactness instance-attribute

compactness: NotRequired[DashCompactness]

The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.

drm_signaling instance-attribute

drm_signaling: NotRequired[DashDrmSignaling]

Determines how the DASH manifest signals the DRM content.

dvb_settings instance-attribute

dvb_settings: NotRequired[DashDvbSettings]

For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.

filter_configuration instance-attribute

filter_configuration: NotRequired[FilterConfiguration]

manifest_name instance-attribute

manifest_name: ResourceName

A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.

manifest_window_seconds instance-attribute

manifest_window_seconds: NotRequired[int]

The total duration (in seconds) of the manifest's content.

min_buffer_time_seconds instance-attribute

min_buffer_time_seconds: NotRequired[int]

Minimum amount of content (in seconds) that a player must keep available in the buffer.

min_update_period_seconds instance-attribute

min_update_period_seconds: NotRequired[int]

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

period_triggers instance-attribute

period_triggers: NotRequired[DashPeriodTriggers]

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

profiles instance-attribute

profiles: NotRequired[DashProfiles]

The profile that the output is compliant with.

program_information instance-attribute

program_information: NotRequired[DashProgramInformation]

Details about the content that you want MediaPackage to pass through in the manifest to the playback device.

scte_dash instance-attribute

scte_dash: NotRequired[ScteDash]

The SCTE configuration.

segment_template_format instance-attribute

segment_template_format: NotRequired[DashSegmentTemplateFormat]

Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

Value description:

  • NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

subtitle_configuration instance-attribute

subtitle_configuration: NotRequired[DashSubtitleConfiguration]

The configuration for DASH subtitles.

suggested_presentation_delay_seconds instance-attribute

suggested_presentation_delay_seconds: NotRequired[int]

The amount of time (in seconds) that the player should be from the end of the manifest.

uri_path_type instance-attribute

uri_path_type: NotRequired[UriPathType]

The type of path used in manifest URIs. LEAF indicates leaf-relative paths. ROOT indicates root-relative paths that include the full path from root.

url instance-attribute

url: str

The egress domain URL for stream delivery from MediaPackage.

utc_timing instance-attribute

utc_timing: NotRequired[DashUtcTiming]

Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).