Package software.amazon.awscdk.services.mediapackagev2

Interface CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnOriginEndpoint

@Stability(Stable)
public static interface CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Specify a low-latency HTTP live streaming (LL-HLS) manifest configuration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediapackagev2.*;
 LowLatencyHlsManifestConfigurationProperty lowLatencyHlsManifestConfigurationProperty = LowLatencyHlsManifestConfigurationProperty.builder()
         .manifestName("manifestName")
         // the properties below are optional
         .childManifestName("childManifestName")
         .filterConfiguration(FilterConfigurationProperty.builder()
                 .clipStartTime("clipStartTime")
                 .end("end")
                 .manifestFilter("manifestFilter")
                 .start("start")
                 .timeDelaySeconds(123)
                 .build())
         .manifestWindowSeconds(123)
         .programDateTimeIntervalSeconds(123)
         .scteHls(ScteHlsProperty.builder()
                 .adMarkerHls("adMarkerHls")
                 .build())
         .startTag(StartTagProperty.builder()
                 .timeOffset(123)
                 // the properties below are optional
                 .precise(false)
                 .build())
         .url("url")
         .urlEncodeChildManifest(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty.Builder	A builder for CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty
static final class	CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty.Jsii$Proxy	An implementation for CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty.Builder	builder()
default String	getChildManifestName()	The name of the child manifest associated with the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint.
default Object	getFilterConfiguration()	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.
String	getManifestName()	A short string that's appended to the endpoint URL.
default Number	getManifestWindowSeconds()	The total duration (in seconds) of the manifest's content.
default Number	getProgramDateTimeIntervalSeconds()	Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify.
default Object	getScteHls()	The SCTE-35 HLS configuration associated with the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint.
default Object	getStartTag()	To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset.
default String	getUrl()	The URL of the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint.
default Object	getUrlEncodeChildManifest()	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getManifestName

@Stability(Stable)
@NotNull
String getManifestName()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-manifestname

getChildManifestName

@Stability(Stable)
@Nullable
default String getChildManifestName()

The name of the child manifest associated with the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-childmanifestname

getFilterConfiguration

@Stability(Stable)
@Nullable
default Object getFilterConfiguration()

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.

Returns union: either IResolvable or CfnOriginEndpoint.FilterConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-filterconfiguration

getManifestWindowSeconds

@Stability(Stable)
@Nullable
default Number getManifestWindowSeconds()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-manifestwindowseconds

getProgramDateTimeIntervalSeconds

@Stability(Stable)
@Nullable
default Number getProgramDateTimeIntervalSeconds()

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, MediaPackage passes through that metadata to the HLS output.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-programdatetimeintervalseconds

getScteHls

@Stability(Stable)
@Nullable
default Object getScteHls()

The SCTE-35 HLS configuration associated with the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint.

Returns union: either IResolvable or CfnOriginEndpoint.ScteHlsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-sctehls

getStartTag

@Stability(Stable)
@Nullable
default Object getStartTag()

To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset.

When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.

Returns union: either IResolvable or CfnOriginEndpoint.StartTagProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-starttag

getUrl

@Stability(Stable)
@Nullable
default String getUrl()

The URL of the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-url

getUrlEncodeChildManifest

@Stability(Stable)
@Nullable
default Object getUrlEncodeChildManifest()

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 .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-urlencodechildmanifest

builder

@Stability(Stable)
static CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty.Builder builder()

Returns:

a CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty.Builder of CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty