aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
950 lines • 513 kB
TypeScript
import * as cdk from "../../core";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
/**
* The AWS::MediaLive::Channel resource is a MediaLive resource type that creates a channel.
*
* A MediaLive channel ingests and transcodes (decodes and encodes) source content from the inputs that are attached to that channel, and packages the new content into outputs.
*
* @cloudformationResource AWS::MediaLive::Channel
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html
*/
export declare class CfnChannel extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnChannel from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnChannel;
/**
* The ARN of the MediaLive channel. For example: arn:aws:medialive:us-west-1:111122223333:medialive:channel:1234567
*
* @cloudformationAttribute Arn
*/
readonly attrArn: string;
/**
* User-specified id. This is used in an output group or an output.
*
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The inputs that are attached to this channel. The inputs are identified by their IDs (not by their names or their ARNs).
*
* @cloudformationAttribute Inputs
*/
readonly attrInputs: Array<string>;
anywhereSettings?: CfnChannel.AnywhereSettingsProperty | cdk.IResolvable;
/**
* Specification of CDI inputs for this channel.
*/
cdiInputSpecification?: CfnChannel.CdiInputSpecificationProperty | cdk.IResolvable;
/**
* The class for this channel.
*/
channelClass?: string;
channelEngineVersion?: CfnChannel.ChannelEngineVersionRequestProperty | cdk.IResolvable;
/**
* The settings that identify the destination for the outputs in this MediaLive output package.
*/
destinations?: Array<cdk.IResolvable | CfnChannel.OutputDestinationProperty> | cdk.IResolvable;
dryRun?: boolean | cdk.IResolvable;
/**
* The encoding configuration for the output content.
*/
encoderSettings?: CfnChannel.EncoderSettingsProperty | cdk.IResolvable;
/**
* The list of input attachments for the channel.
*/
inputAttachments?: Array<CfnChannel.InputAttachmentProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The input specification for this channel.
*/
inputSpecification?: CfnChannel.InputSpecificationProperty | cdk.IResolvable;
/**
* The verbosity for logging activity for this channel.
*/
logLevel?: string;
/**
* Maintenance settings for this channel.
*/
maintenance?: cdk.IResolvable | CfnChannel.MaintenanceCreateSettingsProperty;
/**
* Name of channel.
*/
name?: string;
/**
* The IAM role for MediaLive to assume when running this channel.
*/
roleArn?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* A collection of tags for this channel.
*/
tagsRaw?: any;
/**
* Settings to enable VPC mode in the channel, so that the endpoints for all outputs are in your VPC.
*/
vpc?: cdk.IResolvable | CfnChannel.VpcOutputSettingsProperty;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props?: CfnChannelProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnChannel {
/**
* An input to attach to this channel.
*
* This entity is at the top level in the channel.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html
*/
interface InputAttachmentProperty {
/**
* Settings to implement automatic input failover in this input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html#cfn-medialive-channel-inputattachment-automaticinputfailoversettings
*/
readonly automaticInputFailoverSettings?: CfnChannel.AutomaticInputFailoverSettingsProperty | cdk.IResolvable;
/**
* A name for the attachment.
*
* This is required if you want to use this input in an input switch action.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html#cfn-medialive-channel-inputattachment-inputattachmentname
*/
readonly inputAttachmentName?: string;
/**
* The ID of the input to attach.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html#cfn-medialive-channel-inputattachment-inputid
*/
readonly inputId?: string;
/**
* Information about the content to extract from the input and about the general handling of the content.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html#cfn-medialive-channel-inputattachment-inputsettings
*/
readonly inputSettings?: CfnChannel.InputSettingsProperty | cdk.IResolvable;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html#cfn-medialive-channel-inputattachment-logicalinterfacenames
*/
readonly logicalInterfaceNames?: Array<string>;
}
/**
* Settings to configure the conditions that will define the input as unhealthy and that will make MediaLive fail over to the other input in the input failover pair.
*
* The parent of this entity is InputAttachment.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-automaticinputfailoversettings.html
*/
interface AutomaticInputFailoverSettingsProperty {
/**
* This clear time defines the requirement a recovered input must meet to be considered healthy.
*
* The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input_preference for the failover pair is set to PRIMARY_INPUT_PREFERRED, because after this time, MediaLive will switch back to the primary input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-automaticinputfailoversettings.html#cfn-medialive-channel-automaticinputfailoversettings-errorcleartimemsec
*/
readonly errorClearTimeMsec?: number;
/**
* A list of failover conditions.
*
* If any of these conditions occur, MediaLive will perform a failover to the other input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-automaticinputfailoversettings.html#cfn-medialive-channel-automaticinputfailoversettings-failoverconditions
*/
readonly failoverConditions?: Array<CfnChannel.FailoverConditionProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Input preference when deciding which input to make active when a previously failed input has recovered.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-automaticinputfailoversettings.html#cfn-medialive-channel-automaticinputfailoversettings-inputpreference
*/
readonly inputPreference?: string;
/**
* The input ID of the secondary input in the automatic input failover pair.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-automaticinputfailoversettings.html#cfn-medialive-channel-automaticinputfailoversettings-secondaryinputid
*/
readonly secondaryInputId?: string;
}
/**
* Failover Condition settings. There can be multiple failover conditions inside AutomaticInputFailoverSettings.
*
* The parent of this entity is AutomaticInputFailoverSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-failovercondition.html
*/
interface FailoverConditionProperty {
/**
* Settings for a specific failover condition.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-failovercondition.html#cfn-medialive-channel-failovercondition-failoverconditionsettings
*/
readonly failoverConditionSettings?: CfnChannel.FailoverConditionSettingsProperty | cdk.IResolvable;
}
/**
* Settings for one failover condition.
*
* The parent of this entity is FailoverCondition.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-failoverconditionsettings.html
*/
interface FailoverConditionSettingsProperty {
/**
* MediaLive will perform a failover if the specified audio selector is silent for the specified period.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-failoverconditionsettings.html#cfn-medialive-channel-failoverconditionsettings-audiosilencesettings
*/
readonly audioSilenceSettings?: CfnChannel.AudioSilenceFailoverSettingsProperty | cdk.IResolvable;
/**
* MediaLive will perform a failover if content is not detected in this input for the specified period.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-failoverconditionsettings.html#cfn-medialive-channel-failoverconditionsettings-inputlosssettings
*/
readonly inputLossSettings?: CfnChannel.InputLossFailoverSettingsProperty | cdk.IResolvable;
/**
* MediaLive will perform a failover if content is considered black for the specified period.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-failoverconditionsettings.html#cfn-medialive-channel-failoverconditionsettings-videoblacksettings
*/
readonly videoBlackSettings?: cdk.IResolvable | CfnChannel.VideoBlackFailoverSettingsProperty;
}
/**
* MediaLive will perform a failover if audio is not detected in this input for the specified period.
*
* The parent of this entity is FailoverConditionSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiosilencefailoversettings.html
*/
interface AudioSilenceFailoverSettingsProperty {
/**
* The name of the audio selector in the input that MediaLive should monitor to detect silence.
*
* Select your most important rendition. If you didn't create an audio selector in this input, leave blank.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiosilencefailoversettings.html#cfn-medialive-channel-audiosilencefailoversettings-audioselectorname
*/
readonly audioSelectorName?: string;
/**
* The amount of time (in milliseconds) that the active input must be silent before automatic input failover occurs.
*
* Silence is defined as audio loss or audio quieter than -50 dBFS.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiosilencefailoversettings.html#cfn-medialive-channel-audiosilencefailoversettings-audiosilencethresholdmsec
*/
readonly audioSilenceThresholdMsec?: number;
}
/**
* MediaLive will perform a failover if content is considered black for the specified period.
*
* The parent of this entity is FailoverConditionSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoblackfailoversettings.html
*/
interface VideoBlackFailoverSettingsProperty {
/**
* A value used in calculating the threshold below which MediaLive considers a pixel to be 'black'.
*
* For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (1023*0.1=102.3), which means a pixel value of 102 or less is 'black'. If you set this field to .1 in an 8-bit color depth: (255*0.1=25.5), which means a pixel value of 25 or less is 'black'. The range is 0.0 to 1.0, with any number of decimal places.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoblackfailoversettings.html#cfn-medialive-channel-videoblackfailoversettings-blackdetectthreshold
*/
readonly blackDetectThreshold?: number;
/**
* The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoblackfailoversettings.html#cfn-medialive-channel-videoblackfailoversettings-videoblackthresholdmsec
*/
readonly videoBlackThresholdMsec?: number;
}
/**
* MediaLive will perform a failover if content is not detected in this input for the specified period.
*
* The parent of this entity is FailoverConditionSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlossfailoversettings.html
*/
interface InputLossFailoverSettingsProperty {
/**
* The amount of time (in milliseconds) that no input is detected.
*
* After that time, an input failover will occur.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlossfailoversettings.html#cfn-medialive-channel-inputlossfailoversettings-inputlossthresholdmsec
*/
readonly inputLossThresholdMsec?: number;
}
/**
* Information about extracting content from the input and about handling the content.
*
* The parent of this entity is InputAttachment.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html
*/
interface InputSettingsProperty {
/**
* Information about the specific audio to extract from the input.
*
* The parent of this entity is InputSettings.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-audioselectors
*/
readonly audioSelectors?: Array<CfnChannel.AudioSelectorProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Information about the specific captions to extract from the input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-captionselectors
*/
readonly captionSelectors?: Array<CfnChannel.CaptionSelectorProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Enables or disables the deblock filter when filtering.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-deblockfilter
*/
readonly deblockFilter?: string;
/**
* Enables or disables the denoise filter when filtering.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-denoisefilter
*/
readonly denoiseFilter?: string;
/**
* Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-filterstrength
*/
readonly filterStrength?: number;
/**
* Turns on the filter for this input.
*
* MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering is applied depending on input type/quality 2) disabled - no filtering is applied to the input 3) forced - filtering is applied regardless of the input type.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-inputfilter
*/
readonly inputFilter?: string;
/**
* Information about how to connect to the upstream system.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-networkinputsettings
*/
readonly networkInputSettings?: cdk.IResolvable | CfnChannel.NetworkInputSettingsProperty;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-scte35pid
*/
readonly scte35Pid?: number;
/**
* Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input.
*
* Applicable data types are captions, timecode, AFD, and SCTE-104 messages.
* - PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any).
* - IGNORE: Never extract any ancillary data from SMPTE-2038.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-smpte2038datapreference
*/
readonly smpte2038DataPreference?: string;
/**
* The loop input if it is a file.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-sourceendbehavior
*/
readonly sourceEndBehavior?: string;
/**
* Information about one video to extract from the input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-videoselector
*/
readonly videoSelector?: cdk.IResolvable | CfnChannel.VideoSelectorProperty;
}
/**
* Information about the video to extract from the input. An input can contain only one video selector.
*
* The parent of this entity is InputSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.html
*/
interface VideoSelectorProperty {
/**
* Specifies the color space of an input.
*
* This setting works in tandem with colorSpaceConversion to determine if MediaLive will perform any conversion.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.html#cfn-medialive-channel-videoselector-colorspace
*/
readonly colorSpace?: string;
/**
* Settings to configure color space settings in the incoming video.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.html#cfn-medialive-channel-videoselector-colorspacesettings
*/
readonly colorSpaceSettings?: cdk.IResolvable | CfnChannel.VideoSelectorColorSpaceSettingsProperty;
/**
* Applies only if colorSpace is a value other than Follow.
*
* This field controls how the value in the colorSpace field is used. Fallback means that when the input does include color space data, that data is used, but when the input has no color space data, the value in colorSpace is used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. Force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.html#cfn-medialive-channel-videoselector-colorspaceusage
*/
readonly colorSpaceUsage?: string;
/**
* Information about the video to select from the content.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.html#cfn-medialive-channel-videoselector-selectorsettings
*/
readonly selectorSettings?: cdk.IResolvable | CfnChannel.VideoSelectorSettingsProperty;
}
/**
* Settings to configure color space settings in the incoming video.
*
* The parent of this entity is VideoSelector.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorcolorspacesettings.html
*/
interface VideoSelectorColorSpaceSettingsProperty {
/**
* Settings to configure color space settings in the incoming video.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorcolorspacesettings.html#cfn-medialive-channel-videoselectorcolorspacesettings-hdr10settings
*/
readonly hdr10Settings?: CfnChannel.Hdr10SettingsProperty | cdk.IResolvable;
}
/**
* Hdr10 Settings.
*
* The parents of this entity are H265ColorSpaceSettings (for color space settings in the output) and VideoSelectorColorSpaceSettings (for color space settings in the input).
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hdr10settings.html
*/
interface Hdr10SettingsProperty {
/**
* Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hdr10settings.html#cfn-medialive-channel-hdr10settings-maxcll
*/
readonly maxCll?: number;
/**
* Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hdr10settings.html#cfn-medialive-channel-hdr10settings-maxfall
*/
readonly maxFall?: number;
}
/**
* Information about the video to extract from the input.
*
* The parent of this entity is VideoSelector.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorsettings.html
*/
interface VideoSelectorSettingsProperty {
/**
* Used to extract video by PID.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorsettings.html#cfn-medialive-channel-videoselectorsettings-videoselectorpid
*/
readonly videoSelectorPid?: cdk.IResolvable | CfnChannel.VideoSelectorPidProperty;
/**
* Used to extract video by program ID.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorsettings.html#cfn-medialive-channel-videoselectorsettings-videoselectorprogramid
*/
readonly videoSelectorProgramId?: cdk.IResolvable | CfnChannel.VideoSelectorProgramIdProperty;
}
/**
* Used to extract video by the program ID.
*
* The parent of this entity is VideoSelectorSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorprogramid.html
*/
interface VideoSelectorProgramIdProperty {
/**
* Selects a specific program from within a multi-program transport stream.
*
* If the program doesn't exist, MediaLive selects the first program within the transport stream by default.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorprogramid.html#cfn-medialive-channel-videoselectorprogramid-programid
*/
readonly programId?: number;
}
/**
* Selects a specific PID from within a video source.
*
* The parent of this entity is VideoSelectorSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorpid.html
*/
interface VideoSelectorPidProperty {
/**
* Selects a specific PID from within a video source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorpid.html#cfn-medialive-channel-videoselectorpid-pid
*/
readonly pid?: number;
}
/**
* Information about one audio to extract from the input.
*
* The parent of this entity is InputSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioselector.html
*/
interface AudioSelectorProperty {
/**
* A name for this AudioSelector.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioselector.html#cfn-medialive-channel-audioselector-name
*/
readonly name?: string;
/**
* Information about the specific audio to extract from the input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioselector.html#cfn-medialive-channel-audioselector-selectorsettings
*/
readonly selectorSettings?: CfnChannel.AudioSelectorSettingsProperty | cdk.IResolvable;
}
/**
* Information about the audio to extract from the input.
*
* The parent of this entity is AudioSelector.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioselectorsettings.html
*/
interface AudioSelectorSettingsProperty {
/**
* Selector for HLS audio rendition.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioselectorsettings.html#cfn-medialive-channel-audioselectorsettings-audiohlsrenditionselection
*/
readonly audioHlsRenditionSelection?: CfnChannel.AudioHlsRenditionSelectionProperty | cdk.IResolvable;
/**
* The language code of the audio to select.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioselectorsettings.html#cfn-medialive-channel-audioselectorsettings-audiolanguageselection
*/
readonly audioLanguageSelection?: CfnChannel.AudioLanguageSelectionProperty | cdk.IResolvable;
/**
* The PID of the audio to select.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioselectorsettings.html#cfn-medialive-channel-audioselectorsettings-audiopidselection
*/
readonly audioPidSelection?: CfnChannel.AudioPidSelectionProperty | cdk.IResolvable;
/**
* Information about the audio track to extract.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioselectorsettings.html#cfn-medialive-channel-audioselectorsettings-audiotrackselection
*/
readonly audioTrackSelection?: CfnChannel.AudioTrackSelectionProperty | cdk.IResolvable;
}
/**
* Used to extract audio by The PID.
*
* The parent of this entity is AudioSelectorSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiopidselection.html
*/
interface AudioPidSelectionProperty {
/**
* Select the audio by this PID.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiopidselection.html#cfn-medialive-channel-audiopidselection-pid
*/
readonly pid?: number;
}
/**
* Information about the audio language to extract.
*
* The parent of this entity is AudioSelectorSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiolanguageselection.html
*/
interface AudioLanguageSelectionProperty {
/**
* Selects a specific three-letter language code from within an audio source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiolanguageselection.html#cfn-medialive-channel-audiolanguageselection-languagecode
*/
readonly languageCode?: string;
/**
* When set to "strict," the transport stream demux strictly identifies audio streams by their language descriptor.
*
* If a PMT update occurs such that an audio stream matching the initially selected language is no longer present, then mute is encoded until the language returns. If set to "loose," then on a PMT update the demux chooses another audio stream in the program with the same stream type if it can't find one with the same language.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiolanguageselection.html#cfn-medialive-channel-audiolanguageselection-languageselectionpolicy
*/
readonly languageSelectionPolicy?: string;
}
/**
* Information about the audio track to extract.
*
* The parent of this entity is AudioSelectorSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiotrackselection.html
*/
interface AudioTrackSelectionProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiotrackselection.html#cfn-medialive-channel-audiotrackselection-dolbyedecode
*/
readonly dolbyEDecode?: CfnChannel.AudioDolbyEDecodeProperty | cdk.IResolvable;
/**
* Selects one or more unique audio tracks from within a source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiotrackselection.html#cfn-medialive-channel-audiotrackselection-tracks
*/
readonly tracks?: Array<CfnChannel.AudioTrackProperty | cdk.IResolvable> | cdk.IResolvable;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodolbyedecode.html
*/
interface AudioDolbyEDecodeProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodolbyedecode.html#cfn-medialive-channel-audiodolbyedecode-programselection
*/
readonly programSelection?: string;
}
/**
* Information about one audio track to extract. You can select multiple tracks.
*
* The parent of this entity is AudioTrackSelection.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiotrack.html
*/
interface AudioTrackProperty {
/**
* 1-based integer value that maps to a specific audio track.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiotrack.html#cfn-medialive-channel-audiotrack-track
*/
readonly track?: number;
}
/**
* Selector for HLS audio rendition.
*
* The parent of this entity is AudioSelectorSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiohlsrenditionselection.html
*/
interface AudioHlsRenditionSelectionProperty {
/**
* Specifies the GROUP-ID in the #EXT-X-MEDIA tag of the target HLS audio rendition.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiohlsrenditionselection.html#cfn-medialive-channel-audiohlsrenditionselection-groupid
*/
readonly groupId?: string;
/**
* Specifies the NAME in the #EXT-X-MEDIA tag of the target HLS audio rendition.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiohlsrenditionselection.html#cfn-medialive-channel-audiohlsrenditionselection-name
*/
readonly name?: string;
}
/**
* Information about one caption to extract from the input.
*
* The parent of this entity is InputSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselector.html
*/
interface CaptionSelectorProperty {
/**
* When specified, this field indicates the three-letter language code of the captions track to extract from the source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselector.html#cfn-medialive-channel-captionselector-languagecode
*/
readonly languageCode?: string;
/**
* The name identifier for a captions selector.
*
* This name is used to associate this captions selector with one or more captions descriptions. Names must be unique within a channel.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselector.html#cfn-medialive-channel-captionselector-name
*/
readonly name?: string;
/**
* Information about the specific audio to extract from the input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselector.html#cfn-medialive-channel-captionselector-selectorsettings
*/
readonly selectorSettings?: CfnChannel.CaptionSelectorSettingsProperty | cdk.IResolvable;
}
/**
* Captions Selector Settings.
*
* The parent of this entity is CaptionSelector.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselectorsettings.html
*/
interface CaptionSelectorSettingsProperty {
/**
* Information about the ancillary captions to extract from the input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselectorsettings.html#cfn-medialive-channel-captionselectorsettings-ancillarysourcesettings
*/
readonly ancillarySourceSettings?: CfnChannel.AncillarySourceSettingsProperty | cdk.IResolvable;
/**
* Information about the ARIB captions to extract from the input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselectorsettings.html#cfn-medialive-channel-captionselectorsettings-aribsourcesettings
*/
readonly aribSourceSettings?: CfnChannel.AribSourceSettingsProperty | cdk.IResolvable;
/**
* Information about the DVB Sub captions to extract from the input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselectorsettings.html#cfn-medialive-channel-captionselectorsettings-dvbsubsourcesettings
*/
readonly dvbSubSourceSettings?: CfnChannel.DvbSubSourceSettingsProperty | cdk.IResolvable;
/**
* Information about the embedded captions to extract from the input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselectorsettings.html#cfn-medialive-channel-captionselectorsettings-embeddedsourcesettings
*/
readonly embeddedSourceSettings?: CfnChannel.EmbeddedSourceSettingsProperty | cdk.IResolvable;
/**
* Information about the SCTE-20 captions to extract from the input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselectorsettings.html#cfn-medialive-channel-captionselectorsettings-scte20sourcesettings
*/
readonly scte20SourceSettings?: cdk.IResolvable | CfnChannel.Scte20SourceSettingsProperty;
/**
* Information about the SCTE-27 captions to extract from the input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselectorsettings.html#cfn-medialive-channel-captionselectorsettings-scte27sourcesettings
*/
readonly scte27SourceSettings?: cdk.IResolvable | CfnChannel.Scte27SourceSettingsProperty;
/**
* Information about the Teletext captions to extract from the input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionselectorsettings.html#cfn-medialive-channel-captionselectorsettings-teletextsourcesettings
*/
readonly teletextSourceSettings?: cdk.IResolvable | CfnChannel.TeletextSourceSettingsProperty;
}
/**
* Information about the DVB Sub captions to extract from the input.
*
* The parent of this entity is CaptionSelectorSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubsourcesettings.html
*/
interface DvbSubSourceSettingsProperty {
/**
* If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubsourcesettings.html#cfn-medialive-channel-dvbsubsourcesettings-ocrlanguage
*/
readonly ocrLanguage?: string;
/**
* When using DVB-Sub with burn-in or SMPTE-TT, use this PID for the source content.
*
* It is unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubsourcesettings.html#cfn-medialive-channel-dvbsubsourcesettings-pid
*/
readonly pid?: number;
}
/**
* Information about the SCTE-27 captions to extract from the input.
*
* The parent of this entity is CaptionSelectorSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte27sourcesettings.html
*/
interface Scte27SourceSettingsProperty {
/**
* If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte27sourcesettings.html#cfn-medialive-channel-scte27sourcesettings-ocrlanguage
*/
readonly ocrLanguage?: string;
/**
* The PID field is used in conjunction with the captions selector languageCode field as follows: Specify PID and Language: Extracts captions from that PID;
*
* the language is "informational." Specify PID and omit Language: Extracts the specified PID. Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages are passed through.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte27sourcesettings.html#cfn-medialive-channel-scte27sourcesettings-pid
*/
readonly pid?: number;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-aribsourcesettings.html
*/
interface AribSourceSettingsProperty {
}
/**
* Information about the embedded captions to extract from the input.
*
* The parent of this entity is CaptionSelectorSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-embeddedsourcesettings.html
*/
interface EmbeddedSourceSettingsProperty {
/**
* If this is upconvert, 608 data is both passed through the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708.
*
* If 708 data is present in the source content, it is discarded.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-embeddedsourcesettings.html#cfn-medialive-channel-embeddedsourcesettings-convert608to708
*/
readonly convert608To708?: string;
/**
* Set to "auto" to handle streams with intermittent or non-aligned SCTE-20 and embedded captions.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-embeddedsourcesettings.html#cfn-medialive-channel-embeddedsourcesettings-scte20detection
*/
readonly scte20Detection?: string;
/**
* Specifies the 608/708 channel number within the video track from which to extract captions.
*
* This is unused for passthrough.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-embeddedsourcesettings.html#cfn-medialive-channel-embeddedsourcesettings-source608channelnumber
*/
readonly source608ChannelNumber?: number;
/**
* This field is unused and deprecated.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-embeddedsourcesettings.html#cfn-medialive-channel-embeddedsourcesettings-source608tracknumber
*/
readonly source608TrackNumber?: number;
}
/**
* Information about the SCTE-20 captions to extract from the input.
*
* The parent of this entity is CaptionSelectorSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte20sourcesettings.html
*/
interface Scte20SourceSettingsProperty {
/**
* If upconvert, 608 data is both passed through the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708.
*
* Any 708 data present in the source content is discarded.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte20sourcesettings.html#cfn-medialive-channel-scte20sourcesettings-convert608to708
*/
readonly convert608To708?: string;
/**
* Specifies the 608/708 channel number within the video track from which to extract captions.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte20sourcesettings.html#cfn-medialive-channel-scte20sourcesettings-source608channelnumber
*/
readonly source608ChannelNumber?: number;
}
/**
* Information about the Teletext captions to extract from the input.
*
* The parent of this entity is CaptionSelectorSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-teletextsourcesettings.html
*/
interface TeletextSourceSettingsProperty {
/**
* Settings to configure the caption rectangle for an output captions that will be created using this Teletext source captions.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-teletextsourcesettings.html#cfn-medialive-channel-teletextsourcesettings-outputrectangle
*/
readonly outputRectangle?: CfnChannel.CaptionRectangleProperty | cdk.IResolvable;
/**
* Specifies the Teletext page number within the data stream from which to extract captions.
*
* The range is 0x100 (256) to 0x8FF (2303). This is unused for passthrough. It should be specified as a hexadecimal string with no "0x" prefix.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-teletextsourcesettings.html#cfn-medialive-channel-teletextsourcesettings-pagenumber
*/
readonly pageNumber?: string;
}
/**
* Settings to configure the caption rectangle for an output captions that will be created using this Teletext source captions.
*
* The parent of this entity is TeletextSourceSettings.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionrectangle.html
*/
interface CaptionRectangleProperty {
/**
* See the description in leftOffset.
*
* For height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \"80\" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less. This field corresponds to tts:e