Struct aws_sdk_mediapackage::types::builders::HlsManifestBuilder

#[non_exhaustive]
pub struct HlsManifestBuilder { /* private fields */ }

A builder for HlsManifest.

Implementations

impl HlsManifestBuilder

pub fn ad_markers(self, input: AdMarkers) -> Self

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 set_ad_markers(self, input: Option<AdMarkers>) -> Self

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 get_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, input: impl Into<String>) -> Self

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

pub fn set_id(self, input: Option<String>) -> Self

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

pub fn get_id(&self) -> &Option<String>

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, input: bool) -> Self

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

pub fn set_include_iframe_only_stream(self, input: Option<bool>) -> Self

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

pub fn get_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, input: impl Into<String>) -> Self

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

pub fn set_manifest_name(self, input: Option<String>) -> Self

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

pub fn get_manifest_name(&self) -> &Option<String>

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, input: PlaylistType) -> Self

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 set_playlist_type(self, input: Option<PlaylistType>) -> Self

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 get_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, input: i32) -> Self

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

pub fn set_playlist_window_seconds(self, input: Option<i32>) -> Self

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

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

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

pub fn program_date_time_interval_seconds(self, input: i32) -> Self

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 set_program_date_time_interval_seconds(self, input: Option<i32>) -> Self

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 get_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, input: impl Into<String>) -> Self

The URL of the packaged OriginEndpoint for consumption.

pub fn set_url(self, input: Option<String>) -> Self

The URL of the packaged OriginEndpoint for consumption.

pub fn get_url(&self) -> &Option<String>

The URL of the packaged OriginEndpoint for consumption.

pub fn ad_triggers(self, input: AdTriggersElement) -> Self

Appends an item to ad_triggers.

To override the contents of this collection use set_ad_triggers.

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.

pub fn set_ad_triggers(self, input: Option<Vec<AdTriggersElement>>) -> Self

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.

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

pub fn ads_on_delivery_restrictions( self, input: AdsOnDeliveryRestrictions ) -> Self

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.

pub fn set_ads_on_delivery_restrictions( self, input: Option<AdsOnDeliveryRestrictions> ) -> Self

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.

pub fn get_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.

pub fn build(self) -> HlsManifest

Consumes the builder and constructs a HlsManifest.

Trait Implementations

impl Clone for HlsManifestBuilder

fn clone(&self) -> HlsManifestBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HlsManifestBuilder

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

Formats the value using the given formatter.

impl Default for HlsManifestBuilder

fn default() -> HlsManifestBuilder

Returns the “default value” for a type.

impl PartialEq for HlsManifestBuilder

fn eq(&self, other: &HlsManifestBuilder) -> 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 HlsManifestBuilder