Struct aws_sdk_mediapackage::types::HlsManifest

#[non_exhaustive]
pub struct HlsManifest {
    pub ad_markers: Option<AdMarkers>,
    pub id: Option<String>,
    pub include_iframe_only_stream: Option<bool>,
    pub manifest_name: Option<String>,
    pub playlist_type: Option<PlaylistType>,
    pub playlist_window_seconds: Option<i32>,
    pub program_date_time_interval_seconds: Option<i32>,
    pub url: Option<String>,
    pub ad_triggers: Option<Vec<AdTriggersElement>>,
    pub ads_on_delivery_restrictions: Option<AdsOnDeliveryRestrictions>,
}

A HTTP Live Streaming (HLS) manifest configuration.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ad_markers: Option<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: Option<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: Option<bool>

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

manifest_name: Option<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: Option<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: Option<i32>

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

program_date_time_interval_seconds: Option<i32>

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: Option<String>

The URL of the packaged OriginEndpoint for consumption.

ad_triggers: Option<Vec<AdTriggersElement>>

A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.

ads_on_delivery_restrictions: Option<AdsOnDeliveryRestrictions>

This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing “NONE” means no SCTE-35 messages become ads. Choosing “RESTRICTED” means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing “UNRESTRICTED” means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing “BOTH” means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.

Implementations

impl HlsManifest

pub fn ad_markers(&self) -> Option<&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.

pub fn id(&self) -> Option<&str>

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

pub fn include_iframe_only_stream(&self) -> Option<bool>

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

pub fn manifest_name(&self) -> Option<&str>

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

pub fn playlist_type(&self) -> Option<&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.

pub fn playlist_window_seconds(&self) -> Option<i32>

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

pub fn program_date_time_interval_seconds(&self) -> Option<i32>

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.

pub fn url(&self) -> Option<&str>

The URL of the packaged OriginEndpoint for consumption.

pub fn ad_triggers(&self) -> &[AdTriggersElement]

A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .ad_triggers.is_none().

pub fn ads_on_delivery_restrictions(&self) -> Option<&AdsOnDeliveryRestrictions>

This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing “NONE” means no SCTE-35 messages become ads. Choosing “RESTRICTED” means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing “UNRESTRICTED” means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing “BOTH” means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.

impl HlsManifest

pub fn builder() -> HlsManifestBuilder

Creates a new builder-style object to manufacture HlsManifest.

Trait Implementations

impl Clone for HlsManifest

fn clone(&self) -> HlsManifest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HlsManifest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for HlsManifest

fn eq(&self, other: &HlsManifest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HlsManifest