Manifest

class aws_cdk.aws_mediapackagev2_alpha.Manifest

Bases: object

(experimental) Manifest to add to Origin Endpoint.

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_mediapackagev2_alpha as mediapackagev2_alpha
import aws_cdk as cdk

# manifest_filter: mediapackagev2_alpha.ManifestFilter

manifest = mediapackagev2_alpha.Manifest.dash(
    manifest_name="manifestName",

    # the properties below are optional
    base_urls=[mediapackagev2_alpha.DashBaseUrlProperty(
        url="url",

        # the properties below are optional
        dvb_priority=123,
        dvb_weight=123,
        service_location="serviceLocation"
    )],
    compactness=mediapackagev2_alpha.DashManifestCompactness.STANDARD,
    drm_signalling=mediapackagev2_alpha.DrmSignalling.INDIVIDUAL,
    dvb_settings=mediapackagev2_alpha.DashDvbSettings(
        error_metrics=[mediapackagev2_alpha.DashDvbMetricsReporting(
            reporting_url="reportingUrl",

            # the properties below are optional
            probability=123
        )],
        font_download=mediapackagev2_alpha.DashDvbFontDownload(
            font_family="fontFamily",
            mime_type="mimeType",
            url="url"
        )
    ),
    filter_configuration=mediapackagev2_alpha.FilterConfiguration(
        clip_start_time=Date(),
        drm_settings=[mediapackagev2_alpha.DrmSettingsKey.EXCLUDE_SESSION_KEYS],
        end=Date(),
        manifest_filter=[manifest_filter],
        start=Date(),
        time_delay=cdk.Duration.minutes(30)
    ),
    manifest_window=cdk.Duration.minutes(30),
    min_buffer_time=cdk.Duration.minutes(30),
    min_update_period=cdk.Duration.minutes(30),
    period_triggers=[mediapackagev2_alpha.DashPeriodTriggers.AVAILS],
    profiles=["profiles"],
    program_information=mediapackagev2_alpha.DashProgramInformation(
        copyright="copyright",
        language_code="languageCode",
        more_information_url="moreInformationUrl",
        source="source",
        title="title"
    ),
    scte_dash_ad_marker=mediapackagev2_alpha.AdMarkerDash.BINARY,
    segment_template_format=mediapackagev2_alpha.SegmentTemplateFormat.NUMBER_WITH_TIMELINE,
    subtitle_configuration=mediapackagev2_alpha.DashSubtitleConfiguration(
        ttml_configuration=mediapackagev2_alpha.DashTtmlConfiguration(
            ttml_profile=mediapackagev2_alpha.TtmlProfile.IMSC_1
        )
    ),
    suggested_presentation_delay=cdk.Duration.minutes(30),
    utc_timing_mode=mediapackagev2_alpha.DashUtcTimingMode.HTTP_HEAD,
    utc_timing_source="utcTimingSource"
)
Stability:

experimental

Static Methods

classmethod dash(*, manifest_name, base_urls=None, compactness=None, drm_signalling=None, dvb_settings=None, filter_configuration=None, manifest_window=None, min_buffer_time=None, min_update_period=None, period_triggers=None, profiles=None, program_information=None, scte_dash_ad_marker=None, segment_template_format=None, subtitle_configuration=None, suggested_presentation_delay=None, utc_timing_mode=None, utc_timing_source=None)

(experimental) Specify a manifest configuration for DASH.

Note: DASH manifests require CMAF container type. Use with Segment.cmaf().

Parameters:

  • manifest_name (str) – (experimental) The name of the manifest associated with the DASH manifest configuration.

  • base_urls (Optional[Sequence[Union[DashBaseUrlProperty, Dict[str, Any]]]]) – (experimental) The base URLs to use for retrieving segments. Default: - No base URLs specified

  • compactness (Optional[DashManifestCompactness]) – (experimental) The layout of the DASH manifest that MediaPackage produces. Default: DashManifestCompactness.STANDARD

  • drm_signalling (Optional[DrmSignalling]) – (experimental) DRM signaling determines the way DASH manifest signals the DRM content. Default: - No DRM signaling specified

  • dvb_settings (Union[DashDvbSettings, Dict[str, Any], None]) – (experimental) For endpoints that use the DVB-DASH profile only. Default: - No DVB settings

  • filter_configuration (Union[FilterConfiguration, Dict[str, Any], None]) – (experimental) Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. https://docs.aws.amazon.com/mediapackage/latest/userguide/manifest-filter-query-parameters.html Default: - No filter configuration

  • manifest_window (Optional[Duration]) – (experimental) The total duration (in seconds) of the manifest’s content. Default: 60

  • min_buffer_time (Optional[Duration]) – (experimental) The minimum amount of content that the player must keep available in the buffer. Default: 5

  • min_update_period (Optional[Duration]) – (experimental) The minimum amount of time for the player to wait before requesting an updated manifest. Default: 2

  • period_triggers (Optional[Sequence[DashPeriodTriggers]]) – (experimental) Specify what triggers cause AWS Elemental MediaPackage to create media presentation description (MPD) periods in the output manifest. Default: [DashPeriodTriggers.AVAILS, DashPeriodTriggers.DRM_KEY_ROTATION, DashPeriodTriggers.SOURCE_CHANGES, DashPeriodTriggers.SOURCE_DISRUPTIONS]

  • profiles (Optional[Sequence[str]]) – (experimental) The profile that the output is compliant with. Default: - No profiles specified

  • program_information (Union[DashProgramInformation, Dict[str, Any], None]) – (experimental) Details about the content that you want MediaPackage to pass through in the manifest to the playback device. Default: - No program information

  • scte_dash_ad_marker (Optional[AdMarkerDash]) – (experimental) Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. To choose this option STCE filtering needs to be enabled. Default: AdMarkerDash.XML

  • segment_template_format (Optional[SegmentTemplateFormat]) – (experimental) The type of variable that MediaPackage uses in the media attribute of the SegmentTemplate tag. Default: SegmentTemplateFormat.NUMBER_WITH_TIMELINE

  • subtitle_configuration (Union[DashSubtitleConfiguration, Dict[str, Any], None]) – (experimental) The configuration for DASH subtitles. Default: - No subtitle configuration

  • suggested_presentation_delay (Optional[Duration]) – (experimental) The amount of time that the player should be from the end of the manifest. Default: 10

  • utc_timing_mode (Optional[DashUtcTimingMode]) – (experimental) The UTC timing mode. Default: DashUtcTimingMode.UTC_DIRECT

  • utc_timing_source (Optional[str]) – (experimental) The method that the player uses to synchronize to coordinated universal time (UTC) wall clock time. Default: undefined - No value is specified

Stability:

experimental

Return type:

Manifest

classmethod hls(*, manifest_name, child_manifest_name=None, filter_configuration=None, manifest_window=None, program_date_time_interval=None, scte_ad_marker_hls=None, start_tag=None, url_encode_child_manifest=None)

(experimental) Specify a manifest configuration for HLS.

Note: HLS manifests require TS or CMAF container type. Use with Segment.ts() or Segment.cmaf().

Parameters:

  • manifest_name (str) – (experimental) The name of the manifest associated with the HLS manifest configuration.

  • child_manifest_name (Optional[str]) – (experimental) The name of the child manifest associated with the HLS manifest configuration. Default: - No child manifest name specified

  • filter_configuration (Union[FilterConfiguration, Dict[str, Any], None]) – (experimental) Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. https://docs.aws.amazon.com/mediapackage/latest/userguide/manifest-filter-query-parameters.html Default: - No filter configuration

  • manifest_window (Optional[Duration]) – (experimental) The total duration (in seconds) of the manifest’s content. Default: 60

  • program_date_time_interval (Optional[Duration]) – (experimental) 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. Default: - No program date time interval

  • scte_ad_marker_hls (Optional[AdMarkerHls]) – (experimental) The SCTE-35 HLS configuration associated with the HLS manifest configuration of the origin endpoint. Default: - No SCTE ad marker configuration

  • start_tag (Optional[StartTag]) – (experimental) Insert EXT-X-START tag in the manifest with the configured settings. Default: - No start tag

  • url_encode_child_manifest (Optional[bool]) – (experimental) When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with AWS Signature Version 4 (SigV4) signature signing protocol. For more information, see AWS Signature Version 4 for API requests in AWS Identity and Access Management User Guide. Default: false

Stability:

experimental

Return type:

Manifest

classmethod low_latency_hls(*, manifest_name, child_manifest_name=None, filter_configuration=None, manifest_window=None, program_date_time_interval=None, scte_ad_marker_hls=None, start_tag=None, url_encode_child_manifest=None)

(experimental) Specify a manifest configuration for Low Latency HLS.

Note: Low Latency HLS manifests require TS or CMAF container type. Use with Segment.ts() or Segment.cmaf().

Parameters:

  • manifest_name (str) – (experimental) 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. 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.

  • child_manifest_name (Optional[str]) – (experimental) The name of the child manifest associated with the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint. Default: - No child manifest name specified

  • filter_configuration (Union[FilterConfiguration, Dict[str, Any], None]) – (experimental) Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. https://docs.aws.amazon.com/mediapackage/latest/userguide/manifest-filter-query-parameters.html Default: - No filter configuration

  • manifest_window (Optional[Duration]) – (experimental) The total duration (in seconds) of the manifest’s content. Default: 60

  • program_date_time_interval (Optional[Duration]) – (experimental) 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. Default: - No program date time interval

  • scte_ad_marker_hls (Optional[AdMarkerHls]) – (experimental) The SCTE-35 HLS configuration associated with the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint. Default: - No SCTE ad marker configuration

  • start_tag (Optional[StartTag]) – (experimental) Insert EXT-X-START tag in the manifest with the configured settings. Default: - No start tag

  • url_encode_child_manifest (Optional[bool]) – (experimental) When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with AWS Signature Version 4 (SigV4) signature signing protocol. For more information, see AWS Signature Version 4 for API requests in AWS Identity and Access Management User Guide. Default: false

Stability:

experimental

Return type:

Manifest

classmethod mss(*, manifest_name, filter_configuration=None, manifest_layout=None, manifest_window=None)

(experimental) Specify a manifest configuration for MSS.

Note: MSS manifests require ISM container type. Use with Segment.ism().

Parameters:
Stability:

experimental

Return type:

Manifest