interface HlsManifestProperty

Language	Type name
.NET	`Amazon.CDK.AWS.MediaPackage.CfnOriginEndpoint.HlsManifestProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsmediapackage#CfnOriginEndpoint_HlsManifestProperty`
Java	`software.amazon.awscdk.services.mediapackage.CfnOriginEndpoint.HlsManifestProperty`
Python	`aws_cdk.aws_mediapackage.CfnOriginEndpoint.HlsManifestProperty`
TypeScript	`aws-cdk-lib` » `aws_mediapackage` » `CfnOriginEndpoint` » `HlsManifestProperty`

An HTTP Live Streaming (HLS) manifest configuration on a CMAF endpoint.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediapackage as mediapackage } from 'aws-cdk-lib';
const hlsManifestProperty: mediapackage.CfnOriginEndpoint.HlsManifestProperty = {
  id: 'id',

  // the properties below are optional
  adMarkers: 'adMarkers',
  adsOnDeliveryRestrictions: 'adsOnDeliveryRestrictions',
  adTriggers: ['adTriggers'],
  includeIframeOnlyStream: false,
  manifestName: 'manifestName',
  playlistType: 'playlistType',
  playlistWindowSeconds: 123,
  programDateTimeIntervalSeconds: 123,
  url: 'url',
};

Properties

Name	Type	Description
id	`string`	The manifest ID is required and must be unique within the OriginEndpoint.
adMarkers?	`string`	Controls how ad markers are included in the packaged endpoint.
adTriggers?	`string[]`	Specifies the SCTE-35 message types that AWS Elemental MediaPackage treats as ad markers in the output manifest.
adsOnDeliveryRestrictions?	`string`	The flags on SCTE-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest.
includeIframeOnlyStream?	`boolean \|` `IResolvable`	Applies to stream sets with a single video track only.
manifestName?	`string`	A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.
playlistType?	`string`	When specified as either `event` or `vod` , a corresponding `EXT-X-PLAYLIST-TYPE` entry is included in the media playlist.
playlistWindowSeconds?	`number`	Time window (in seconds) contained in each parent manifest.
programDateTimeIntervalSeconds?	`number`	Inserts `EXT-X-PROGRAM-DATE-TIME` tags in the output manifest at the interval that you specify.
url?	`string`	The URL that's used to request this manifest from this endpoint.

id

Type: string

The manifest ID is required and must be unique within the OriginEndpoint.

The ID can't be changed after the endpoint is created.

adMarkers?

Type: string (optional)

Controls how ad markers are included in the packaged endpoint.

Valid values:

NONE - Omits all SCTE-35 ad markers from the output.
PASSTHROUGH - Creates a copy in the output of the SCTE-35 ad markers (comments) taken directly from the input manifest.
SCTE35_ENHANCED - Generates ad markers and blackout tags in the output based on the SCTE-35 messages from the input manifest.

adTriggers?

Type: string[] (optional)

Specifies the SCTE-35 message types that AWS Elemental MediaPackage treats as ad markers in the output manifest.

Valid values:

BREAK
DISTRIBUTOR_ADVERTISEMENT
DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY
DISTRIBUTOR_PLACEMENT_OPPORTUNITY
PROVIDER_ADVERTISEMENT
PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY
PROVIDER_PLACEMENT_OPPORTUNITY
SPLICE_INSERT

adsOnDeliveryRestrictions?

Type: string (optional)

The flags on SCTE-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest.

For information about SCTE-35 in AWS Elemental MediaPackage , see SCTE-35 Message Options in AWS Elemental MediaPackage .

includeIframeOnlyStream?

Type: boolean | IResolvable (optional)

Applies to stream sets with a single video track only.

When true, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included.

manifestName?

Type: string (optional)

A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.

The manifestName on the HLSManifest object overrides the manifestName that you provided on the originEndpoint object.

playlistType?

Type: string (optional)

When specified as either event or vod , a corresponding EXT-X-PLAYLIST-TYPE entry is included in the media playlist.

Indicates if the playlist is live-to-VOD content.

playlistWindowSeconds?

Type: number (optional)

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

programDateTimeIntervalSeconds?

Type: number (optional)

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify.

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

Omit this attribute or enter 0 to indicate that the EXT-X-PROGRAM-DATE-TIME tags are not included in the manifest.

url?

Type: string (optional)

The URL that's used to request this manifest from this endpoint.