Package software.amazon.awscdk.services.mediapackagev2

Interface CfnOriginEndpoint.DashManifestConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOriginEndpoint.DashManifestConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnOriginEndpoint

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

The DASH manifest configuration associated with the origin endpoint.

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.*;
 DashManifestConfigurationProperty dashManifestConfigurationProperty = DashManifestConfigurationProperty.builder()
         .manifestName("manifestName")
         // the properties below are optional
         .baseUrls(List.of(DashBaseUrlProperty.builder()
                 .url("url")
                 // the properties below are optional
                 .dvbPriority(123)
                 .dvbWeight(123)
                 .serviceLocation("serviceLocation")
                 .build()))
         .compactness("compactness")
         .drmSignaling("drmSignaling")
         .dvbSettings(DashDvbSettingsProperty.builder()
                 .errorMetrics(List.of(DashDvbMetricsReportingProperty.builder()
                         .reportingUrl("reportingUrl")
                         // the properties below are optional
                         .probability(123)
                         .build()))
                 .fontDownload(DashDvbFontDownloadProperty.builder()
                         .fontFamily("fontFamily")
                         .mimeType("mimeType")
                         .url("url")
                         .build())
                 .build())
         .filterConfiguration(FilterConfigurationProperty.builder()
                 .clipStartTime("clipStartTime")
                 .end("end")
                 .manifestFilter("manifestFilter")
                 .start("start")
                 .timeDelaySeconds(123)
                 .build())
         .manifestWindowSeconds(123)
         .minBufferTimeSeconds(123)
         .minUpdatePeriodSeconds(123)
         .periodTriggers(List.of("periodTriggers"))
         .profiles(List.of("profiles"))
         .programInformation(DashProgramInformationProperty.builder()
                 .copyright("copyright")
                 .languageCode("languageCode")
                 .moreInformationUrl("moreInformationUrl")
                 .source("source")
                 .title("title")
                 .build())
         .scteDash(ScteDashProperty.builder()
                 .adMarkerDash("adMarkerDash")
                 .build())
         .segmentTemplateFormat("segmentTemplateFormat")
         .subtitleConfiguration(DashSubtitleConfigurationProperty.builder()
                 .ttmlConfiguration(DashTtmlConfigurationProperty.builder()
                         .ttmlProfile("ttmlProfile")
                         .build())
                 .build())
         .suggestedPresentationDelaySeconds(123)
         .utcTiming(DashUtcTimingProperty.builder()
                 .timingMode("timingMode")
                 .timingSource("timingSource")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnOriginEndpoint.DashManifestConfigurationProperty.Builder	builder()
default Object	getBaseUrls()	The base URLs to use for retrieving segments.
default String	getCompactness()	The layout of the DASH manifest that MediaPackage produces.
default String	getDrmSignaling()	Determines how the DASH manifest signals the DRM content.
default Object	getDvbSettings()	For endpoints that use the DVB-DASH profile only.
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	getMinBufferTimeSeconds()	Minimum amount of content (in seconds) that a player must keep available in the buffer.
default Number	getMinUpdatePeriodSeconds()	Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.
default List<String>	getPeriodTriggers()	A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods.
default List<String>	getProfiles()	The profile that the output is compliant with.
default Object	getProgramInformation()	Details about the content that you want MediaPackage to pass through in the manifest to the playback device.
default Object	getScteDash()	The SCTE configuration.
default String	getSegmentTemplateFormat()	Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest.
default Object	getSubtitleConfiguration()	The configuration for DASH subtitles.
default Number	getSuggestedPresentationDelaySeconds()	The amount of time (in seconds) that the player should be from the end of the manifest.
default Object	getUtcTiming()	Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

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 child manifest name creates a unique path to this endpoint.

See Also:

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

getBaseUrls

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

The base URLs to use for retrieving segments.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnOriginEndpoint.DashBaseUrlProperty>

See Also:

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

getCompactness

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

The layout of the DASH manifest that MediaPackage produces.

STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.

For information about compactness, see DASH manifest compactness in the AWS Elemental MediaPackage v2 User Guide .

See Also:

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

getDrmSignaling

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

Determines how the DASH manifest signals the DRM content.

See Also:

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

getDvbSettings

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

For endpoints that use the DVB-DASH profile only.

The font download and error reporting information that you want MediaPackage to pass through to the manifest.

Returns union: either IResolvable or CfnOriginEndpoint.DashDvbSettingsProperty

See Also:

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

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-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-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-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-manifestwindowseconds

getMinBufferTimeSeconds

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

Minimum amount of content (in seconds) that a player must keep available in the buffer.

See Also:

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

getMinUpdatePeriodSeconds

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

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

See Also:

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

getPeriodTriggers

@Stability(Stable)
@Nullable
default List<String> getPeriodTriggers()

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods.

Type ADS to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage .

See Also:

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

getProfiles

@Stability(Stable)
@Nullable
default List<String> getProfiles()

The profile that the output is compliant with.

See Also:

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

getProgramInformation

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

Details about the content that you want MediaPackage to pass through in the manifest to the playback device.

Returns union: either IResolvable or CfnOriginEndpoint.DashProgramInformationProperty

See Also:

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

getScteDash

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

The SCTE configuration.

Returns union: either IResolvable or CfnOriginEndpoint.ScteDashProperty

See Also:

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

getSegmentTemplateFormat

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

Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest.

Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate .

Value description:

• NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate .

See Also:

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

getSubtitleConfiguration

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

The configuration for DASH subtitles.

Returns union: either IResolvable or CfnOriginEndpoint.DashSubtitleConfigurationProperty

See Also:

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

getSuggestedPresentationDelaySeconds

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

The amount of time (in seconds) that the player should be from the end of the manifest.

See Also:

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

getUtcTiming

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

Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

Returns union: either IResolvable or CfnOriginEndpoint.DashUtcTimingProperty

See Also:

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

builder

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

Returns:

a CfnOriginEndpoint.DashManifestConfigurationProperty.Builder of CfnOriginEndpoint.DashManifestConfigurationProperty