interface AlternateMediaProperty

Language	Type name
.NET	Amazon.CDK.AWS.MediaTailor.CfnProgram.AlternateMediaProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsmediatailor#CfnProgram_AlternateMediaProperty
Java	software.amazon.awscdk.services.mediatailor.CfnProgram.AlternateMediaProperty
Python	aws_cdk.aws_mediatailor.CfnProgram.AlternateMediaProperty
TypeScript	aws-cdk-lib » aws_mediatailor » CfnProgram » AlternateMediaProperty

A playlist of media to be played instead of the default media on a particular program.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediatailor as mediatailor } from 'aws-cdk-lib';
const alternateMediaProperty: mediatailor.CfnProgram.AlternateMediaProperty = {
  adBreaks: [{
    offsetMillis: 123,

    // the properties below are optional
    adBreakMetadata: [{
      key: 'key',
      value: 'value',
    }],
    messageType: 'messageType',
    slate: {
      sourceLocationName: 'sourceLocationName',
      vodSourceName: 'vodSourceName',
    },
    spliceInsertMessage: {
      availNum: 123,
      availsExpected: 123,
      spliceEventId: 123,
      uniqueProgramId: 123,
    },
    timeSignalMessage: {
      segmentationDescriptors: [{
        segmentationEventId: 123,
        segmentationTypeId: 123,
        segmentationUpid: 'segmentationUpid',
        segmentationUpidType: 123,
        segmentNum: 123,
        segmentsExpected: 123,
        subSegmentNum: 123,
        subSegmentsExpected: 123,
      }],
    },
  }],
  clipRange: {
    endOffsetMillis: 123,
    startOffsetMillis: 123,
  },
  durationMillis: 123,
  liveSourceName: 'liveSourceName',
  scheduledStartTimeMillis: 123,
  sourceLocationName: 'sourceLocationName',
  vodSourceName: 'vodSourceName',
};

Properties

Name	Type	Description
adBreaks?	IResolvable | (IResolvable | AdBreakProperty)[]	Ad break configuration parameters defined in AlternateMedia.
clipRange?	IResolvable | ClipRangeProperty	Clip range configuration for the VOD source associated with the program.
durationMillis?	number	The duration of the alternateMedia in milliseconds.
liveSourceName?	string	The name of the live source for alternateMedia.
scheduledStartTimeMillis?	number	The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
sourceLocationName?	string	The name of the source location for alternateMedia.
vodSourceName?	string	The name of the VOD source for alternateMedia.

---

adBreaks?

Type: IResolvable | (IResolvable | AdBreakProperty)[] (optional)

Ad break configuration parameters defined in AlternateMedia.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-adbreaks

---

clipRange?

Type: IResolvable | ClipRangeProperty (optional)

Clip range configuration for the VOD source associated with the program.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-cliprange

---

durationMillis?

Type: number (optional)

The duration of the alternateMedia in milliseconds.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-durationmillis

---

liveSourceName?

Type: string (optional)

The name of the live source for alternateMedia.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-livesourcename

---

scheduledStartTimeMillis?

Type: number (optional)

The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-scheduledstarttimemillis

---

sourceLocationName?

Type: string (optional)

The name of the source location for alternateMedia.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-sourcelocationname

---

vodSourceName?

Type: string (optional)

The name of the VOD source for alternateMedia.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-vodsourcename