Skip to content

GetHlsManifestConfiguration

Source code in docs_src/capo_mediapackagev2/types/get_hls_manifest_configuration.py
class GetHlsManifestConfiguration(TypedDict, closed=True):
    manifest_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<p>A short 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. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.</p>"""
    url: "str"
    """<p>The egress domain URL for stream delivery from MediaPackage.</p>"""
    child_manifest_name: NotRequired[
        "capo_mediapackagev2.types.resource_name.ResourceName"
    ]
    """<p>A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.</p>"""
    manifest_window_seconds: NotRequired["int"]
    """<p>The total duration (in seconds) of the manifest's content.</p>"""
    program_date_time_interval_seconds: NotRequired["int"]
    """<p>Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.</p> <p>Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.</p>"""
    scte_hls: NotRequired["capo_mediapackagev2.types.scte_hls.ScteHls"]
    filter_configuration: NotRequired[
        "capo_mediapackagev2.types.filter_configuration.FilterConfiguration"
    ]
    start_tag: NotRequired["capo_mediapackagev2.types.start_tag.StartTag"]
    url_encode_child_manifest: NotRequired["bool"]
    """<p>When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html">Amazon Web Services Signature Version 4 for API requests</a> in <i>Identity and Access Management User Guide</i>.</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>"""

child_manifest_name instance-attribute

child_manifest_name: NotRequired[ResourceName]

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

filter_configuration instance-attribute

filter_configuration: NotRequired[FilterConfiguration]

manifest_name instance-attribute

manifest_name: ResourceName

A short 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. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

manifest_window_seconds instance-attribute

manifest_window_seconds: NotRequired[int]

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

program_date_time_interval_seconds instance-attribute

program_date_time_interval_seconds: NotRequired[int]

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

scte_hls instance-attribute

scte_hls: NotRequired[ScteHls]

start_tag instance-attribute

start_tag: NotRequired[StartTag]

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.

url_encode_child_manifest instance-attribute

url_encode_child_manifest: NotRequired[bool]

When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.