Skip to content

HlsManifest

Source code in docs_src/capo_mediapackage/types/hls_manifest.py
class HlsManifest(TypedDict, closed=True):
    ad_markers: NotRequired["capo_mediapackage.types.ad_markers.AdMarkers"]
    """This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0."""
    id: NotRequired["capo_mediapackage.types.__string.__string"]
    """The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created."""
    include_iframe_only_stream: NotRequired[
        "capo_mediapackage.types.__boolean.__boolean"
    ]
    """When enabled, an I-Frame only stream will be included in the output."""
    manifest_name: NotRequired["capo_mediapackage.types.__string.__string"]
    """An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint."""
    playlist_type: NotRequired["capo_mediapackage.types.playlist_type.PlaylistType"]
    """The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist."""
    playlist_window_seconds: NotRequired["capo_mediapackage.types.__integer.__integer"]
    """Time window (in seconds) contained in each parent manifest."""
    program_date_time_interval_seconds: NotRequired[
        "capo_mediapackage.types.__integer.__integer"
    ]
    """The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output."""
    url: NotRequired["capo_mediapackage.types.__string.__string"]
    """The URL of the packaged OriginEndpoint for consumption."""
    ad_triggers: NotRequired["capo_mediapackage.types.ad_triggers.AdTriggers"]
    ads_on_delivery_restrictions: NotRequired[
        "capo_mediapackage.types.ads_on_delivery_restrictions.AdsOnDeliveryRestrictions"
    ]

ad_markers instance-attribute

ad_markers: NotRequired[AdMarkers]

This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.

ad_triggers instance-attribute

ad_triggers: NotRequired[AdTriggers]

ads_on_delivery_restrictions instance-attribute

ads_on_delivery_restrictions: NotRequired[AdsOnDeliveryRestrictions]

id instance-attribute

id: NotRequired[__string]

The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.

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_name instance-attribute

manifest_name: NotRequired[__string]

An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.

playlist_type instance-attribute

playlist_type: NotRequired[PlaylistType]

The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.

playlist_window_seconds instance-attribute

playlist_window_seconds: NotRequired[__integer]

Time window (in seconds) contained in each parent manifest.

program_date_time_interval_seconds instance-attribute

program_date_time_interval_seconds: NotRequired[__integer]

The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.

url instance-attribute

url: NotRequired[__string]

The URL of the packaged OriginEndpoint for consumption.