CfnChannel

class aws_cdk.aws_medialive.CfnChannel(scope, id, *, cdi_input_specification=None, channel_class=None, destinations=None, encoder_settings=None, input_attachments=None, input_specification=None, log_level=None, maintenance=None, name=None, role_arn=None, tags=None, vpc=None)

Bases: CfnResource

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html
CloudformationResource:: AWS::MediaLive::Channel
ExampleMetadata:: fixture=_generated

Example:

:type scope: :py:class:`~constructs.Construct`
:param scope: Scope in which this resource is defined.
:type id: :py:class:`str`
:param id: Construct identifier for this resource (unique in its scope).
:type cdi_input_specification: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_medialive.CfnChannel.CdiInputSpecificationProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`], :py:obj:`None`]
:param cdi_input_specification: Specification of CDI inputs for this channel.
:type channel_class: :py:data:`~typing.Optional`\[:py:class:`str`]
:param channel_class: The class for this channel. For a channel with two pipelines, the class is STANDARD. For a channel with one pipeline, the class is SINGLE_PIPELINE.
:type destinations: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~typing.Sequence`\[:py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_medialive.CfnChannel.OutputDestinationProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`]]], :py:obj:`None`]
:param destinations: The settings that identify the destination for the outputs in this MediaLive output package.
:type encoder_settings: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_medialive.CfnChannel.EncoderSettingsProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`], :py:obj:`None`]
:param encoder_settings: The encoding configuration for the output content.
:type input_attachments: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~typing.Sequence`\[:py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_medialive.CfnChannel.InputAttachmentProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`]]], :py:obj:`None`]
:param input_attachments: The list of input attachments for the channel.
:type input_specification: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_medialive.CfnChannel.InputSpecificationProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`], :py:obj:`None`]
:param input_specification: The input specification for this channel. It specifies the key characteristics of the inputs for this channel: the maximum bitrate, the resolution, and the codec.
:type log_level: :py:data:`~typing.Optional`\[:py:class:`str`]
:param log_level: The verbosity for logging activity for this channel. Charges for logging (which are generated through Amazon CloudWatch Logging) are higher for higher verbosities.
:type maintenance: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_medialive.CfnChannel.MaintenanceCreateSettingsProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`], :py:obj:`None`]
:param maintenance: Maintenance settings for this channel.
:type name: :py:data:`~typing.Optional`\[:py:class:`str`]
:param name: A name for this audio selector. The AudioDescription (in an output) references this name in order to identify a specific input audio to include in that output.
:type role_arn: :py:data:`~typing.Optional`\[:py:class:`str`]
:param role_arn: The IAM role for MediaLive to assume when running this channel. The role is identified by its ARN.
:type tags: :py:data:`~typing.Any`
:param tags: A collection of tags for this channel. Each tag is a key-value pair.
:type vpc: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_medialive.CfnChannel.VpcOutputSettingsProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`], :py:obj:`None`]
:param vpc: Settings to enable VPC mode in the channel, so that the endpoints for all outputs are in your VPC.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::MediaLive::Channel'

attr_arn

The ARN of the MediaLive channel.

For example: arn:aws:medialive:us-west-1:111122223333:medialive:channel:1234567

CloudformationAttribute:: Arn

attr_id

User-specified id.

This is used in an output group or an output.

CloudformationAttribute:: Id

attr_inputs

The inputs that are attached to this channel.

The inputs are identified by their IDs (not by their names or their ARNs).

CloudformationAttribute:: Inputs

cdi_input_specification: Specification of CDI inputs for this channel.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

channel_class: The class for this channel.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

destinations: The settings that identify the destination for the outputs in this MediaLive output package.

encoder_settings: The encoding configuration for the output content.

input_attachments: The list of input attachments for the channel.

input_specification: The input specification for this channel.

log_level: The verbosity for logging activity for this channel.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

maintenance: Maintenance settings for this channel.

name: A name for this audio selector.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

role_arn: The IAM role for MediaLive to assume when running this channel.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: Tag Manager which manages the tags for this resource.

tags_raw: A collection of tags for this channel.

vpc: Settings to enable VPC mode in the channel, so that the endpoints for all outputs are in your VPC.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

AacSettingsProperty

class CfnChannel.AacSettingsProperty(*, bitrate=None, coding_mode=None, input_type=None, profile=None, rate_control_mode=None, raw_format=None, sample_rate=None, spec=None, vbr_quality=None)

Bases: object

The settings for an AAC audio encode in the output.

The parent of this entity is AudioCodecSettings.

Parameters:

bitrate (Union[int, float, None]) – The average bitrate in bits/second. Valid values depend on the rate control mode and profile.
coding_mode (Optional[str]) – Mono, stereo, or 5.1 channel layout. Valid values depend on the rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track, and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.
input_type (Optional[str]) – Set to broadcasterMixedAd when the input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains broadcaster mixed AD. Note that the input received by the encoder must contain pre-mixed audio; MediaLive does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave this set to normal when the input does not contain pre-mixed audio + AD.
profile (Optional[str]) – The AAC profile.
rate_control_mode (Optional[str]) – The rate control mode.
raw_format (Optional[str]) – Sets the LATM/LOAS AAC output for raw containers.
sample_rate (Union[int, float, None]) – The sample rate in Hz. Valid values depend on the rate control mode and profile.
spec (Optional[str]) – Uses MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
vbr_quality (Optional[str]) – The VBR quality level. This is used only if rateControlMode is VBR.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-aacsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

aac_settings_property = medialive.CfnChannel.AacSettingsProperty(
    bitrate=123,
    coding_mode="codingMode",
    input_type="inputType",
    profile="profile",
    rate_control_mode="rateControlMode",
    raw_format="rawFormat",
    sample_rate=123,
    spec="spec",
    vbr_quality="vbrQuality"
)

Attributes

bitrate

The average bitrate in bits/second.

Valid values depend on the rate control mode and profile.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-aacsettings.html#cfn-medialive-channel-aacsettings-bitrate

coding_mode

Mono, stereo, or 5.1 channel layout. Valid values depend on the rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track, and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-aacsettings.html#cfn-medialive-channel-aacsettings-codingmode

input_type

Set to broadcasterMixedAd when the input contains pre-mixed main audio + AD (narration) as a stereo pair.

The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains broadcaster mixed AD. Note that the input received by the encoder must contain pre-mixed audio; MediaLive does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave this set to normal when the input does not contain pre-mixed audio + AD.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-aacsettings.html#cfn-medialive-channel-aacsettings-inputtype

profile

The AAC profile.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-aacsettings.html#cfn-medialive-channel-aacsettings-profile

rate_control_mode

The rate control mode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-aacsettings.html#cfn-medialive-channel-aacsettings-ratecontrolmode

raw_format

Sets the LATM/LOAS AAC output for raw containers.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-aacsettings.html#cfn-medialive-channel-aacsettings-rawformat

sample_rate

The sample rate in Hz.

Valid values depend on the rate control mode and profile.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-aacsettings.html#cfn-medialive-channel-aacsettings-samplerate

spec

Uses MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-aacsettings.html#cfn-medialive-channel-aacsettings-spec

vbr_quality

The VBR quality level.

This is used only if rateControlMode is VBR.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-aacsettings.html#cfn-medialive-channel-aacsettings-vbrquality

Ac3SettingsProperty

class CfnChannel.Ac3SettingsProperty(*, attenuation_control=None, bitrate=None, bitstream_mode=None, coding_mode=None, dialnorm=None, drc_profile=None, lfe_filter=None, metadata_control=None)

Bases: object

The settings for an AC3 audio encode in the output.

The parent of this entity is AudioCodecSettings.

Parameters:

attenuation_control (Optional[str]) –
bitrate (Union[int, float, None]) – The average bitrate in bits/second. Valid bitrates depend on the coding mode.
bitstream_mode (Optional[str]) – Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. For more information about these values, see ATSC A/52-2012.
coding_mode (Optional[str]) – The Dolby Digital coding mode. This determines the number of channels.
dialnorm (Union[int, float, None]) – Sets the dialnorm for the output. If excluded and the input audio is Dolby Digital, dialnorm is passed through.
drc_profile (Optional[str]) – If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.
lfe_filter (Optional[str]) – When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. This is valid only in codingMode32Lfe mode.
metadata_control (Optional[str]) – When set to followInput, encoder metadata is sourced from the DD, DD+, or DolbyE decoder that supplies this audio data. If the audio is supplied from one of these streams, the static metadata settings are used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ac3settings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

ac3_settings_property = medialive.CfnChannel.Ac3SettingsProperty(
    attenuation_control="attenuationControl",
    bitrate=123,
    bitstream_mode="bitstreamMode",
    coding_mode="codingMode",
    dialnorm=123,
    drc_profile="drcProfile",
    lfe_filter="lfeFilter",
    metadata_control="metadataControl"
)

Attributes

attenuation_control

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ac3settings.html#cfn-medialive-channel-ac3settings-attenuationcontrol

Type:: see

bitrate

The average bitrate in bits/second.

Valid bitrates depend on the coding mode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ac3settings.html#cfn-medialive-channel-ac3settings-bitrate

bitstream_mode

Specifies the bitstream mode (bsmod) for the emitted AC-3 stream.

For more information about these values, see ATSC A/52-2012.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ac3settings.html#cfn-medialive-channel-ac3settings-bitstreammode

coding_mode

The Dolby Digital coding mode.

This determines the number of channels.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ac3settings.html#cfn-medialive-channel-ac3settings-codingmode

dialnorm

Sets the dialnorm for the output.

If excluded and the input audio is Dolby Digital, dialnorm is passed through.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ac3settings.html#cfn-medialive-channel-ac3settings-dialnorm

drc_profile

If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ac3settings.html#cfn-medialive-channel-ac3settings-drcprofile

lfe_filter

When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding.

This is valid only in codingMode32Lfe mode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ac3settings.html#cfn-medialive-channel-ac3settings-lfefilter

metadata_control

When set to followInput, encoder metadata is sourced from the DD, DD+, or DolbyE decoder that supplies this audio data.

If the audio is supplied from one of these streams, the static metadata settings are used.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ac3settings.html#cfn-medialive-channel-ac3settings-metadatacontrol

AncillarySourceSettingsProperty

class CfnChannel.AncillarySourceSettingsProperty(*, source_ancillary_channel_number=None)

Bases: object

Information about the ancillary captions to extract from the input.

The parent of this entity is CaptionSelectorSettings.

Parameters:: source_ancillary_channel_number (Union[int, float, None]) – Specifies the number (1 to 4) of the captions channel you want to extract from the ancillary captions. If you plan to convert the ancillary captions to another format, complete this field. If you plan to choose Embedded as the captions destination in the output (to pass through all the channels in the ancillary captions), leave this field blank because MediaLive ignores the field.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ancillarysourcesettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

ancillary_source_settings_property = medialive.CfnChannel.AncillarySourceSettingsProperty(
    source_ancillary_channel_number=123
)

Attributes

source_ancillary_channel_number

Specifies the number (1 to 4) of the captions channel you want to extract from the ancillary captions.

If you plan to convert the ancillary captions to another format, complete this field. If you plan to choose Embedded as the captions destination in the output (to pass through all the channels in the ancillary captions), leave this field blank because MediaLive ignores the field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ancillarysourcesettings.html#cfn-medialive-channel-ancillarysourcesettings-sourceancillarychannelnumber

ArchiveCdnSettingsProperty

class CfnChannel.ArchiveCdnSettingsProperty(*, archive_s3_settings=None)

Bases: object

Settings to configure the destination of an Archive output.

The parent of this entity is ArchiveGroupSettings.

Parameters:: archive_s3_settings (Union[IResolvable, ArchiveS3SettingsProperty, Dict[str, Any], None]) – Sets up Amazon S3 as the destination for this Archive output.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-archivecdnsettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

archive_cdn_settings_property = medialive.CfnChannel.ArchiveCdnSettingsProperty(
    archive_s3_settings=medialive.CfnChannel.ArchiveS3SettingsProperty(
        canned_acl="cannedAcl"
    )
)

Attributes

archive_s3_settings

Sets up Amazon S3 as the destination for this Archive output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-archivecdnsettings.html#cfn-medialive-channel-archivecdnsettings-archives3settings

ArchiveContainerSettingsProperty

class CfnChannel.ArchiveContainerSettingsProperty(*, m2_ts_settings=None, raw_settings=None)

Bases: object

The archive container settings.

The parent of this entity is ArchiveOutputSettings.

Parameters:

m2_ts_settings (Union[IResolvable, M2tsSettingsProperty, Dict[str, Any], None]) – The settings for the M2TS in the archive output.
raw_settings (Union[IResolvable, RawSettingsProperty, Dict[str, Any], None]) – The settings for Raw archive output type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-archivecontainersettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

archive_container_settings_property = medialive.CfnChannel.ArchiveContainerSettingsProperty(
    m2_ts_settings=medialive.CfnChannel.M2tsSettingsProperty(
        absent_input_audio_behavior="absentInputAudioBehavior",
        arib="arib",
        arib_captions_pid="aribCaptionsPid",
        arib_captions_pid_control="aribCaptionsPidControl",
        audio_buffer_model="audioBufferModel",
        audio_frames_per_pes=123,
        audio_pids="audioPids",
        audio_stream_type="audioStreamType",
        bitrate=123,
        buffer_model="bufferModel",
        cc_descriptor="ccDescriptor",
        dvb_nit_settings=medialive.CfnChannel.DvbNitSettingsProperty(
            network_id=123,
            network_name="networkName",
            rep_interval=123
        ),
        dvb_sdt_settings=medialive.CfnChannel.DvbSdtSettingsProperty(
            output_sdt="outputSdt",
            rep_interval=123,
            service_name="serviceName",
            service_provider_name="serviceProviderName"
        ),
        dvb_sub_pids="dvbSubPids",
        dvb_tdt_settings=medialive.CfnChannel.DvbTdtSettingsProperty(
            rep_interval=123
        ),
        dvb_teletext_pid="dvbTeletextPid",
        ebif="ebif",
        ebp_audio_interval="ebpAudioInterval",
        ebp_lookahead_ms=123,
        ebp_placement="ebpPlacement",
        ecm_pid="ecmPid",
        es_rate_in_pes="esRateInPes",
        etv_platform_pid="etvPlatformPid",
        etv_signal_pid="etvSignalPid",
        fragment_time=123,
        klv="klv",
        klv_data_pids="klvDataPids",
        nielsen_id3_behavior="nielsenId3Behavior",
        null_packet_bitrate=123,
        pat_interval=123,
        pcr_control="pcrControl",
        pcr_period=123,
        pcr_pid="pcrPid",
        pmt_interval=123,
        pmt_pid="pmtPid",
        program_num=123,
        rate_mode="rateMode",
        scte27_pids="scte27Pids",
        scte35_control="scte35Control",
        scte35_pid="scte35Pid",
        scte35_preroll_pullup_milliseconds=123,
        segmentation_markers="segmentationMarkers",
        segmentation_style="segmentationStyle",
        segmentation_time=123,
        timed_metadata_behavior="timedMetadataBehavior",
        timed_metadata_pid="timedMetadataPid",
        transport_stream_id=123,
        video_pid="videoPid"
    ),
    raw_settings=medialive.CfnChannel.RawSettingsProperty()
)

Attributes

m2_ts_settings

The settings for the M2TS in the archive output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-archivecontainersettings.html#cfn-medialive-channel-archivecontainersettings-m2tssettings

raw_settings

The settings for Raw archive output type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-archivecontainersettings.html#cfn-medialive-channel-archivecontainersettings-rawsettings

ArchiveGroupSettingsProperty

class CfnChannel.ArchiveGroupSettingsProperty(*, archive_cdn_settings=None, destination=None, rollover_interval=None)

Bases: object

The settings for an archive output group.

The parent of this entity is OutputGroupSettings.

Parameters:

archive_cdn_settings (Union[IResolvable, ArchiveCdnSettingsProperty, Dict[str, Any], None]) – Settings to configure the destination of an Archive output.
destination (Union[IResolvable, OutputLocationRefProperty, Dict[str, Any], None]) – A directory and base file name where archive files should be written.
rollover_interval (Union[int, float, None]) – The number of seconds to write to an archive file before closing and starting a new one.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-archivegroupsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

archive_group_settings_property = medialive.CfnChannel.ArchiveGroupSettingsProperty(
    archive_cdn_settings=medialive.CfnChannel.ArchiveCdnSettingsProperty(
        archive_s3_settings=medialive.CfnChannel.ArchiveS3SettingsProperty(
            canned_acl="cannedAcl"
        )
    ),
    destination=medialive.CfnChannel.OutputLocationRefProperty(
        destination_ref_id="destinationRefId"
    ),
    rollover_interval=123
)

Attributes

archive_cdn_settings

Settings to configure the destination of an Archive output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-archivegroupsettings.html#cfn-medialive-channel-archivegroupsettings-archivecdnsettings

destination

A directory and base file name where archive files should be written.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-archivegroupsettings.html#cfn-medialive-channel-archivegroupsettings-destination

rollover_interval

The number of seconds to write to an archive file before closing and starting a new one.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-archivegroupsettings.html#cfn-medialive-channel-archivegroupsettings-rolloverinterval

ArchiveOutputSettingsProperty

class CfnChannel.ArchiveOutputSettingsProperty(*, container_settings=None, extension=None, name_modifier=None)

Bases: object

The archive output settings.

The parent of this entity is OutputSettings.

Parameters:

container_settings (Union[IResolvable, ArchiveContainerSettingsProperty, Dict[str, Any], None]) – The settings that are specific to the container type of the file.
extension (Optional[str]) – The output file extension. If excluded, this is auto-selected from the container type.
name_modifier (Optional[str]) – A string that is concatenated to the end of the destination file name. The string is required for multiple outputs of the same type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-archiveoutputsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

archive_output_settings_property = medialive.CfnChannel.ArchiveOutputSettingsProperty(
    container_settings=medialive.CfnChannel.ArchiveContainerSettingsProperty(
        m2_ts_settings=medialive.CfnChannel.M2tsSettingsProperty(
            absent_input_audio_behavior="absentInputAudioBehavior",
            arib="arib",
            arib_captions_pid="aribCaptionsPid",
            arib_captions_pid_control="aribCaptionsPidControl",
            audio_buffer_model="audioBufferModel",
            audio_frames_per_pes=123,
            audio_pids="audioPids",
            audio_stream_type="audioStreamType",
            bitrate=123,
            buffer_model="bufferModel",
            cc_descriptor="ccDescriptor",
            dvb_nit_settings=medialive.CfnChannel.DvbNitSettingsProperty(
                network_id=123,
                network_name="networkName",
                rep_interval=123
            ),
            dvb_sdt_settings=medialive.CfnChannel.DvbSdtSettingsProperty(
                output_sdt="outputSdt",
                rep_interval=123,
                service_name="serviceName",
                service_provider_name="serviceProviderName"
            ),
            dvb_sub_pids="dvbSubPids",
            dvb_tdt_settings=medialive.CfnChannel.DvbTdtSettingsProperty(
                rep_interval=123
            ),
            dvb_teletext_pid="dvbTeletextPid",
            ebif="ebif",
            ebp_audio_interval="ebpAudioInterval",
            ebp_lookahead_ms=123,
            ebp_placement="ebpPlacement",
            ecm_pid="ecmPid",
            es_rate_in_pes="esRateInPes",
            etv_platform_pid="etvPlatformPid",
            etv_signal_pid="etvSignalPid",
            fragment_time=123,
            klv="klv",
            klv_data_pids="klvDataPids",
            nielsen_id3_behavior="nielsenId3Behavior",
            null_packet_bitrate=123,
            pat_interval=123,
            pcr_control="pcrControl",
            pcr_period=123,
            pcr_pid="pcrPid",
            pmt_interval=123,
            pmt_pid="pmtPid",
            program_num=123,
            rate_mode="rateMode",
            scte27_pids="scte27Pids",
            scte35_control="scte35Control",
            scte35_pid="scte35Pid",
            scte35_preroll_pullup_milliseconds=123,
            segmentation_markers="segmentationMarkers",
            segmentation_style="segmentationStyle",
            segmentation_time=123,
            timed_metadata_behavior="timedMetadataBehavior",
            timed_metadata_pid="timedMetadataPid",
            transport_stream_id=123,
            video_pid="videoPid"
        ),
        raw_settings=medialive.CfnChannel.RawSettingsProperty()
    ),
    extension="extension",
    name_modifier="nameModifier"
)

Attributes

container_settings

The settings that are specific to the container type of the file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-archiveoutputsettings.html#cfn-medialive-channel-archiveoutputsettings-containersettings

extension

The output file extension.

If excluded, this is auto-selected from the container type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-archiveoutputsettings.html#cfn-medialive-channel-archiveoutputsettings-extension

name_modifier

A string that is concatenated to the end of the destination file name.

The string is required for multiple outputs of the same type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-archiveoutputsettings.html#cfn-medialive-channel-archiveoutputsettings-namemodifier

ArchiveS3SettingsProperty

class CfnChannel.ArchiveS3SettingsProperty(*, canned_acl=None)

Bases: object

Sets up Amazon S3 as the destination for this Archive output.

The parent of this entity is ArchiveCdnSettings.

Parameters:: canned_acl (Optional[str]) – Specify the canned ACL to apply to each S3 request. Defaults to none.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-archives3settings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

archive_s3_settings_property = medialive.CfnChannel.ArchiveS3SettingsProperty(
    canned_acl="cannedAcl"
)

Attributes

canned_acl

Specify the canned ACL to apply to each S3 request.

Defaults to none.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-archives3settings.html#cfn-medialive-channel-archives3settings-cannedacl

AribDestinationSettingsProperty

class CfnChannel.AribDestinationSettingsProperty

Bases: object

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-aribdestinationsettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

arib_destination_settings_property = medialive.CfnChannel.AribDestinationSettingsProperty()

AribSourceSettingsProperty

class CfnChannel.AribSourceSettingsProperty

Bases: object

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-aribsourcesettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

arib_source_settings_property = medialive.CfnChannel.AribSourceSettingsProperty()

AudioChannelMappingProperty

class CfnChannel.AudioChannelMappingProperty(*, input_channel_levels=None, output_channel=None)

Bases: object

The settings for remixing audio.

The parent of this entity is RemixSettings.

Parameters:

input_channel_levels (Union[IResolvable, Sequence[Union[IResolvable, InputChannelLevelProperty, Dict[str, Any]]], None]) – The indices and gain values for each input channel that should be remixed into this output channel.
output_channel (Union[int, float, None]) – The index of the output channel that is being produced.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiochannelmapping.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

audio_channel_mapping_property = medialive.CfnChannel.AudioChannelMappingProperty(
    input_channel_levels=[medialive.CfnChannel.InputChannelLevelProperty(
        gain=123,
        input_channel=123
    )],
    output_channel=123
)

Attributes

input_channel_levels

The indices and gain values for each input channel that should be remixed into this output channel.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiochannelmapping.html#cfn-medialive-channel-audiochannelmapping-inputchannellevels

output_channel

The index of the output channel that is being produced.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiochannelmapping.html#cfn-medialive-channel-audiochannelmapping-outputchannel

AudioCodecSettingsProperty

class CfnChannel.AudioCodecSettingsProperty(*, aac_settings=None, ac3_settings=None, eac3_atmos_settings=None, eac3_settings=None, mp2_settings=None, pass_through_settings=None, wav_settings=None)

Bases: object

The configuration of the audio codec in the audio output.

The parent of this entity is AudioDescription.

Parameters:

aac_settings (Union[IResolvable, AacSettingsProperty, Dict[str, Any], None]) – The setup of the AAC audio codec in the output.
ac3_settings (Union[IResolvable, Ac3SettingsProperty, Dict[str, Any], None]) – The setup of an AC3 audio codec in the output.
eac3_atmos_settings (Union[IResolvable, Eac3AtmosSettingsProperty, Dict[str, Any], None]) –
eac3_settings (Union[IResolvable, Eac3SettingsProperty, Dict[str, Any], None]) – The setup of an EAC3 audio codec in the output.
mp2_settings (Union[IResolvable, Mp2SettingsProperty, Dict[str, Any], None]) – The setup of an MP2 audio codec in the output.
pass_through_settings (Union[IResolvable, PassThroughSettingsProperty, Dict[str, Any], None]) – The setup to pass through the Dolby audio codec to the output.
wav_settings (Union[IResolvable, WavSettingsProperty, Dict[str, Any], None]) – Settings for audio encoded with the WAV codec.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiocodecsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

audio_codec_settings_property = medialive.CfnChannel.AudioCodecSettingsProperty(
    aac_settings=medialive.CfnChannel.AacSettingsProperty(
        bitrate=123,
        coding_mode="codingMode",
        input_type="inputType",
        profile="profile",
        rate_control_mode="rateControlMode",
        raw_format="rawFormat",
        sample_rate=123,
        spec="spec",
        vbr_quality="vbrQuality"
    ),
    ac3_settings=medialive.CfnChannel.Ac3SettingsProperty(
        attenuation_control="attenuationControl",
        bitrate=123,
        bitstream_mode="bitstreamMode",
        coding_mode="codingMode",
        dialnorm=123,
        drc_profile="drcProfile",
        lfe_filter="lfeFilter",
        metadata_control="metadataControl"
    ),
    eac3_atmos_settings=medialive.CfnChannel.Eac3AtmosSettingsProperty(
        bitrate=123,
        coding_mode="codingMode",
        dialnorm=123,
        drc_line="drcLine",
        drc_rf="drcRf",
        height_trim=123,
        surround_trim=123
    ),
    eac3_settings=medialive.CfnChannel.Eac3SettingsProperty(
        attenuation_control="attenuationControl",
        bitrate=123,
        bitstream_mode="bitstreamMode",
        coding_mode="codingMode",
        dc_filter="dcFilter",
        dialnorm=123,
        drc_line="drcLine",
        drc_rf="drcRf",
        lfe_control="lfeControl",
        lfe_filter="lfeFilter",
        lo_ro_center_mix_level=123,
        lo_ro_surround_mix_level=123,
        lt_rt_center_mix_level=123,
        lt_rt_surround_mix_level=123,
        metadata_control="metadataControl",
        passthrough_control="passthroughControl",
        phase_control="phaseControl",
        stereo_downmix="stereoDownmix",
        surround_ex_mode="surroundExMode",
        surround_mode="surroundMode"
    ),
    mp2_settings=medialive.CfnChannel.Mp2SettingsProperty(
        bitrate=123,
        coding_mode="codingMode",
        sample_rate=123
    ),
    pass_through_settings=medialive.CfnChannel.PassThroughSettingsProperty(),
    wav_settings=medialive.CfnChannel.WavSettingsProperty(
        bit_depth=123,
        coding_mode="codingMode",
        sample_rate=123
    )
)

Attributes

aac_settings

The setup of the AAC audio codec in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiocodecsettings.html#cfn-medialive-channel-audiocodecsettings-aacsettings

ac3_settings

The setup of an AC3 audio codec in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiocodecsettings.html#cfn-medialive-channel-audiocodecsettings-ac3settings

eac3_atmos_settings

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiocodecsettings.html#cfn-medialive-channel-audiocodecsettings-eac3atmossettings

Type:: see

eac3_settings

The setup of an EAC3 audio codec in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiocodecsettings.html#cfn-medialive-channel-audiocodecsettings-eac3settings

mp2_settings

The setup of an MP2 audio codec in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiocodecsettings.html#cfn-medialive-channel-audiocodecsettings-mp2settings

pass_through_settings

The setup to pass through the Dolby audio codec to the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiocodecsettings.html#cfn-medialive-channel-audiocodecsettings-passthroughsettings

wav_settings

Settings for audio encoded with the WAV codec.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiocodecsettings.html#cfn-medialive-channel-audiocodecsettings-wavsettings

AudioDescriptionProperty

class CfnChannel.AudioDescriptionProperty(*, audio_dash_roles=None, audio_normalization_settings=None, audio_selector_name=None, audio_type=None, audio_type_control=None, audio_watermarking_settings=None, codec_settings=None, dvb_dash_accessibility=None, language_code=None, language_code_control=None, name=None, remix_settings=None, stream_name=None)

Bases: object

The encoding information for one output audio.

The parent of this entity is EncoderSettings.

Parameters:

audio_dash_roles (Optional[Sequence[str]]) –
audio_normalization_settings (Union[IResolvable, AudioNormalizationSettingsProperty, Dict[str, Any], None]) – The advanced audio normalization settings.
audio_selector_name (Optional[str]) – The name of the AudioSelector that is used as the source for this AudioDescription.
audio_type (Optional[str]) – Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
audio_type_control (Optional[str]) – Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.
audio_watermarking_settings (Union[IResolvable, AudioWatermarkSettingsProperty, Dict[str, Any], None]) – Settings to configure one or more solutions that insert audio watermarks in the audio encode.
codec_settings (Union[IResolvable, AudioCodecSettingsProperty, Dict[str, Any], None]) – The audio codec settings.
dvb_dash_accessibility (Optional[str]) –
language_code (Optional[str]) – Indicates the language of the audio output track. Used only if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
language_code_control (Optional[str]) – Choosing followInput causes the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode setting is used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
name (Optional[str]) – The name of this AudioDescription. Outputs use this name to uniquely identify this AudioDescription. Description names should be unique within this channel.
remix_settings (Union[IResolvable, RemixSettingsProperty, Dict[str, Any], None]) – The settings that control how input audio channels are remixed into the output audio channels.
stream_name (Optional[str]) – Used for Microsoft Smooth and Apple HLS outputs. Indicates the name displayed by the player (for example, English or Director Commentary).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodescription.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

audio_description_property = medialive.CfnChannel.AudioDescriptionProperty(
    audio_dash_roles=["audioDashRoles"],
    audio_normalization_settings=medialive.CfnChannel.AudioNormalizationSettingsProperty(
        algorithm="algorithm",
        algorithm_control="algorithmControl",
        target_lkfs=123
    ),
    audio_selector_name="audioSelectorName",
    audio_type="audioType",
    audio_type_control="audioTypeControl",
    audio_watermarking_settings=medialive.CfnChannel.AudioWatermarkSettingsProperty(
        nielsen_watermarks_settings=medialive.CfnChannel.NielsenWatermarksSettingsProperty(
            nielsen_cbet_settings=medialive.CfnChannel.NielsenCBETProperty(
                cbet_check_digit_string="cbetCheckDigitString",
                cbet_stepaside="cbetStepaside",
                csid="csid"
            ),
            nielsen_distribution_type="nielsenDistributionType",
            nielsen_naes_ii_nw_settings=medialive.CfnChannel.NielsenNaesIiNwProperty(
                check_digit_string="checkDigitString",
                sid=123,
                timezone="timezone"
            )
        )
    ),
    codec_settings=medialive.CfnChannel.AudioCodecSettingsProperty(
        aac_settings=medialive.CfnChannel.AacSettingsProperty(
            bitrate=123,
            coding_mode="codingMode",
            input_type="inputType",
            profile="profile",
            rate_control_mode="rateControlMode",
            raw_format="rawFormat",
            sample_rate=123,
            spec="spec",
            vbr_quality="vbrQuality"
        ),
        ac3_settings=medialive.CfnChannel.Ac3SettingsProperty(
            attenuation_control="attenuationControl",
            bitrate=123,
            bitstream_mode="bitstreamMode",
            coding_mode="codingMode",
            dialnorm=123,
            drc_profile="drcProfile",
            lfe_filter="lfeFilter",
            metadata_control="metadataControl"
        ),
        eac3_atmos_settings=medialive.CfnChannel.Eac3AtmosSettingsProperty(
            bitrate=123,
            coding_mode="codingMode",
            dialnorm=123,
            drc_line="drcLine",
            drc_rf="drcRf",
            height_trim=123,
            surround_trim=123
        ),
        eac3_settings=medialive.CfnChannel.Eac3SettingsProperty(
            attenuation_control="attenuationControl",
            bitrate=123,
            bitstream_mode="bitstreamMode",
            coding_mode="codingMode",
            dc_filter="dcFilter",
            dialnorm=123,
            drc_line="drcLine",
            drc_rf="drcRf",
            lfe_control="lfeControl",
            lfe_filter="lfeFilter",
            lo_ro_center_mix_level=123,
            lo_ro_surround_mix_level=123,
            lt_rt_center_mix_level=123,
            lt_rt_surround_mix_level=123,
            metadata_control="metadataControl",
            passthrough_control="passthroughControl",
            phase_control="phaseControl",
            stereo_downmix="stereoDownmix",
            surround_ex_mode="surroundExMode",
            surround_mode="surroundMode"
        ),
        mp2_settings=medialive.CfnChannel.Mp2SettingsProperty(
            bitrate=123,
            coding_mode="codingMode",
            sample_rate=123
        ),
        pass_through_settings=medialive.CfnChannel.PassThroughSettingsProperty(),
        wav_settings=medialive.CfnChannel.WavSettingsProperty(
            bit_depth=123,
            coding_mode="codingMode",
            sample_rate=123
        )
    ),
    dvb_dash_accessibility="dvbDashAccessibility",
    language_code="languageCode",
    language_code_control="languageCodeControl",
    name="name",
    remix_settings=medialive.CfnChannel.RemixSettingsProperty(
        channel_mappings=[medialive.CfnChannel.AudioChannelMappingProperty(
            input_channel_levels=[medialive.CfnChannel.InputChannelLevelProperty(
                gain=123,
                input_channel=123
            )],
            output_channel=123
        )],
        channels_in=123,
        channels_out=123
    ),
    stream_name="streamName"
)

Attributes

audio_dash_roles

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodescription.html#cfn-medialive-channel-audiodescription-audiodashroles

Type:: see

audio_normalization_settings

The advanced audio normalization settings.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodescription.html#cfn-medialive-channel-audiodescription-audionormalizationsettings

audio_selector_name

The name of the AudioSelector that is used as the source for this AudioDescription.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodescription.html#cfn-medialive-channel-audiodescription-audioselectorname

audio_type

Applies only if audioTypeControl is useConfigured.

The values for audioType are defined in ISO-IEC 13818-1.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodescription.html#cfn-medialive-channel-audiodescription-audiotype

audio_type_control

Determines how audio type is determined.

followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodescription.html#cfn-medialive-channel-audiodescription-audiotypecontrol

audio_watermarking_settings

Settings to configure one or more solutions that insert audio watermarks in the audio encode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodescription.html#cfn-medialive-channel-audiodescription-audiowatermarkingsettings

codec_settings

The audio codec settings.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodescription.html#cfn-medialive-channel-audiodescription-codecsettings

dvb_dash_accessibility

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodescription.html#cfn-medialive-channel-audiodescription-dvbdashaccessibility

Type:: see

language_code

Indicates the language of the audio output track.

Used only if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodescription.html#cfn-medialive-channel-audiodescription-languagecode

language_code_control

Choosing followInput causes the ISO 639 language code of the output to follow the ISO 639 language code of the input.

The languageCode setting is used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodescription.html#cfn-medialive-channel-audiodescription-languagecodecontrol

name

The name of this AudioDescription.

Outputs use this name to uniquely identify this AudioDescription. Description names should be unique within this channel.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodescription.html#cfn-medialive-channel-audiodescription-name

remix_settings

The settings that control how input audio channels are remixed into the output audio channels.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodescription.html#cfn-medialive-channel-audiodescription-remixsettings

stream_name

Used for Microsoft Smooth and Apple HLS outputs.

Indicates the name displayed by the player (for example, English or Director Commentary).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodescription.html#cfn-medialive-channel-audiodescription-streamname

AudioDolbyEDecodeProperty

class CfnChannel.AudioDolbyEDecodeProperty(*, program_selection=None)

Bases: object

Parameters:: program_selection (Optional[str]) –
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodolbyedecode.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

audio_dolby_eDecode_property = medialive.CfnChannel.AudioDolbyEDecodeProperty(
    program_selection="programSelection"
)

Attributes

program_selection

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiodolbyedecode.html#cfn-medialive-channel-audiodolbyedecode-programselection

Type:: see

AudioHlsRenditionSelectionProperty

class CfnChannel.AudioHlsRenditionSelectionProperty(*, group_id=None, name=None)

Bases: object

Selector for HLS audio rendition.

The parent of this entity is AudioSelectorSettings.

Parameters:

group_id (Optional[str]) – Specifies the GROUP-ID in the #EXT-X-MEDIA tag of the target HLS audio rendition.
name (Optional[str]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

audio_hls_rendition_selection_property = medialive.CfnChannel.AudioHlsRenditionSelectionProperty(
    group_id="groupId",
    name="name"
)

Attributes

group_id

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

name

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

AudioLanguageSelectionProperty

class CfnChannel.AudioLanguageSelectionProperty(*, language_code=None, language_selection_policy=None)

Bases: object

Information about the audio language to extract.

The parent of this entity is AudioSelectorSettings.

Parameters:

language_code (Optional[str]) – Selects a specific three-letter language code from within an audio source.
language_selection_policy (Optional[str]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

audio_language_selection_property = medialive.CfnChannel.AudioLanguageSelectionProperty(
    language_code="languageCode",
    language_selection_policy="languageSelectionPolicy"
)

Attributes

language_code

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

language_selection_policy

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

AudioNormalizationSettingsProperty

class CfnChannel.AudioNormalizationSettingsProperty(*, algorithm=None, algorithm_control=None, target_lkfs=None)

Bases: object

The settings for normalizing video.

The parent of this entity is AudioDescription.

Parameters:

algorithm (Optional[str]) – The audio normalization algorithm to use. itu17701 conforms to the CALM Act specification. itu17702 conforms to the EBU R-128 specification.
algorithm_control (Optional[str]) – When set to correctAudio, the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio is measured but not adjusted.
target_lkfs (Union[int, float, None]) – The Target LKFS(loudness) to adjust volume to. If no value is entered, a default value is used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audionormalizationsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

audio_normalization_settings_property = medialive.CfnChannel.AudioNormalizationSettingsProperty(
    algorithm="algorithm",
    algorithm_control="algorithmControl",
    target_lkfs=123
)

Attributes

algorithm

The audio normalization algorithm to use.

itu17701 conforms to the CALM Act specification. itu17702 conforms to the EBU R-128 specification.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audionormalizationsettings.html#cfn-medialive-channel-audionormalizationsettings-algorithm

algorithm_control

When set to correctAudio, the output audio is corrected using the chosen algorithm.

If set to measureOnly, the audio is measured but not adjusted.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audionormalizationsettings.html#cfn-medialive-channel-audionormalizationsettings-algorithmcontrol

target_lkfs

The Target LKFS(loudness) to adjust volume to.

If no value is entered, a default value is used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audionormalizationsettings.html#cfn-medialive-channel-audionormalizationsettings-targetlkfs

AudioOnlyHlsSettingsProperty

class CfnChannel.AudioOnlyHlsSettingsProperty(*, audio_group_id=None, audio_only_image=None, audio_track_type=None, segment_type=None)

Bases: object

The configuration of an audio-only HLS output.

The parent of this entity is HlsSettings.

Parameters:

audio_group_id (Optional[str]) – Specifies the group that the audio rendition belongs to.
audio_only_image (Union[IResolvable, InputLocationProperty, Dict[str, Any], None]) – Used with an audio-only stream. It must be a .jpg or .png file. If given, this image is used as the cover art for the audio-only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image; instead, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so it increases bandwidth by {image file size} * {segment count} * {user count.}.
audio_track_type (Optional[str]) – Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client might try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO.
segment_type (Optional[str]) – Specifies the segment type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioonlyhlssettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

audio_only_hls_settings_property = medialive.CfnChannel.AudioOnlyHlsSettingsProperty(
    audio_group_id="audioGroupId",
    audio_only_image=medialive.CfnChannel.InputLocationProperty(
        password_param="passwordParam",
        uri="uri",
        username="username"
    ),
    audio_track_type="audioTrackType",
    segment_type="segmentType"
)

Attributes

audio_group_id

Specifies the group that the audio rendition belongs to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioonlyhlssettings.html#cfn-medialive-channel-audioonlyhlssettings-audiogroupid

audio_only_image

Used with an audio-only stream.

It must be a .jpg or .png file. If given, this image is used as the cover art for the audio-only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image; instead, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so it increases bandwidth by {image file size} * {segment count} * {user count.}.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioonlyhlssettings.html#cfn-medialive-channel-audioonlyhlssettings-audioonlyimage

audio_track_type

Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios.

Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client might try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioonlyhlssettings.html#cfn-medialive-channel-audioonlyhlssettings-audiotracktype
Type:: Four types of audio-only tracks are supported

segment_type

Specifies the segment type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioonlyhlssettings.html#cfn-medialive-channel-audioonlyhlssettings-segmenttype

AudioPidSelectionProperty

class CfnChannel.AudioPidSelectionProperty(*, pid=None)

Bases: object

Used to extract audio by The PID.

The parent of this entity is AudioSelectorSettings.

Parameters:: pid (Union[int, float, None]) – Select the audio by this PID.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiopidselection.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

audio_pid_selection_property = medialive.CfnChannel.AudioPidSelectionProperty(
    pid=123
)

Attributes

pid

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

AudioSelectorProperty

class CfnChannel.AudioSelectorProperty(*, name=None, selector_settings=None)

Bases: object

Information about one audio to extract from the input.

The parent of this entity is InputSettings.

Parameters:

name (Optional[str]) – A name for this AudioSelector.
selector_settings (Union[IResolvable, AudioSelectorSettingsProperty, Dict[str, Any], None]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

audio_selector_property = medialive.CfnChannel.AudioSelectorProperty(
    name="name",
    selector_settings=medialive.CfnChannel.AudioSelectorSettingsProperty(
        audio_hls_rendition_selection=medialive.CfnChannel.AudioHlsRenditionSelectionProperty(
            group_id="groupId",
            name="name"
        ),
        audio_language_selection=medialive.CfnChannel.AudioLanguageSelectionProperty(
            language_code="languageCode",
            language_selection_policy="languageSelectionPolicy"
        ),
        audio_pid_selection=medialive.CfnChannel.AudioPidSelectionProperty(
            pid=123
        ),
        audio_track_selection=medialive.CfnChannel.AudioTrackSelectionProperty(
            dolby_eDecode=medialive.CfnChannel.AudioDolbyEDecodeProperty(
                program_selection="programSelection"
            ),
            tracks=[medialive.CfnChannel.AudioTrackProperty(
                track=123
            )]
        )
    )
)

Attributes

name

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

selector_settings

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

AudioSelectorSettingsProperty

class CfnChannel.AudioSelectorSettingsProperty(*, audio_hls_rendition_selection=None, audio_language_selection=None, audio_pid_selection=None, audio_track_selection=None)

Bases: object

Information about the audio to extract from the input.

The parent of this entity is AudioSelector.

Parameters:

audio_hls_rendition_selection (Union[IResolvable, AudioHlsRenditionSelectionProperty, Dict[str, Any], None]) – Selector for HLS audio rendition.
audio_language_selection (Union[IResolvable, AudioLanguageSelectionProperty, Dict[str, Any], None]) – The language code of the audio to select.
audio_pid_selection (Union[IResolvable, AudioPidSelectionProperty, Dict[str, Any], None]) – The PID of the audio to select.
audio_track_selection (Union[IResolvable, AudioTrackSelectionProperty, Dict[str, Any], None]) – Information about the audio track to extract.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audioselectorsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

audio_selector_settings_property = medialive.CfnChannel.AudioSelectorSettingsProperty(
    audio_hls_rendition_selection=medialive.CfnChannel.AudioHlsRenditionSelectionProperty(
        group_id="groupId",
        name="name"
    ),
    audio_language_selection=medialive.CfnChannel.AudioLanguageSelectionProperty(
        language_code="languageCode",
        language_selection_policy="languageSelectionPolicy"
    ),
    audio_pid_selection=medialive.CfnChannel.AudioPidSelectionProperty(
        pid=123
    ),
    audio_track_selection=medialive.CfnChannel.AudioTrackSelectionProperty(
        dolby_eDecode=medialive.CfnChannel.AudioDolbyEDecodeProperty(
            program_selection="programSelection"
        ),
        tracks=[medialive.CfnChannel.AudioTrackProperty(
            track=123
        )]
    )
)

Attributes

audio_hls_rendition_selection

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

audio_language_selection

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

audio_pid_selection

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

audio_track_selection

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

AudioSilenceFailoverSettingsProperty

class CfnChannel.AudioSilenceFailoverSettingsProperty(*, audio_selector_name=None, audio_silence_threshold_msec=None)

Bases: object

MediaLive will perform a failover if audio is not detected in this input for the specified period.

The parent of this entity is FailoverConditionSettings.

Parameters:

audio_selector_name (Optional[str]) – 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.
audio_silence_threshold_msec (Union[int, float, None]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

audio_silence_failover_settings_property = medialive.CfnChannel.AudioSilenceFailoverSettingsProperty(
    audio_selector_name="audioSelectorName",
    audio_silence_threshold_msec=123
)

Attributes

audio_selector_name

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

audio_silence_threshold_msec

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

AudioTrackProperty

class CfnChannel.AudioTrackProperty(*, track=None)

Bases: object

Information about one audio track to extract. You can select multiple tracks.

The parent of this entity is AudioTrackSelection.

Parameters:: track (Union[int, float, None]) – 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
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

audio_track_property = medialive.CfnChannel.AudioTrackProperty(
    track=123
)

Attributes

track

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

AudioTrackSelectionProperty

class CfnChannel.AudioTrackSelectionProperty(*, dolby_e_decode=None, tracks=None)

Bases: object

Information about the audio track to extract.

The parent of this entity is AudioSelectorSettings.

Parameters:

dolby_e_decode (Union[IResolvable, AudioDolbyEDecodeProperty, Dict[str, Any], None]) –
tracks (Union[IResolvable, Sequence[Union[IResolvable, AudioTrackProperty, Dict[str, Any]]], None]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

audio_track_selection_property = medialive.CfnChannel.AudioTrackSelectionProperty(
    dolby_eDecode=medialive.CfnChannel.AudioDolbyEDecodeProperty(
        program_selection="programSelection"
    ),
    tracks=[medialive.CfnChannel.AudioTrackProperty(
        track=123
    )]
)

Attributes

dolby_e_decode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiotrackselection.html#cfn-medialive-channel-audiotrackselection-dolbyedecode

Type:: see

tracks

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

AudioWatermarkSettingsProperty

class CfnChannel.AudioWatermarkSettingsProperty(*, nielsen_watermarks_settings=None)

Bases: object

Audio Watermark Settings.

The parent of this entity is AudioDescription.

Parameters:: nielsen_watermarks_settings (Union[IResolvable, NielsenWatermarksSettingsProperty, Dict[str, Any], None]) – Settings to configure Nielsen Watermarks in the audio encode.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiowatermarksettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

audio_watermark_settings_property = medialive.CfnChannel.AudioWatermarkSettingsProperty(
    nielsen_watermarks_settings=medialive.CfnChannel.NielsenWatermarksSettingsProperty(
        nielsen_cbet_settings=medialive.CfnChannel.NielsenCBETProperty(
            cbet_check_digit_string="cbetCheckDigitString",
            cbet_stepaside="cbetStepaside",
            csid="csid"
        ),
        nielsen_distribution_type="nielsenDistributionType",
        nielsen_naes_ii_nw_settings=medialive.CfnChannel.NielsenNaesIiNwProperty(
            check_digit_string="checkDigitString",
            sid=123,
            timezone="timezone"
        )
    )
)

Attributes

nielsen_watermarks_settings

Settings to configure Nielsen Watermarks in the audio encode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-audiowatermarksettings.html#cfn-medialive-channel-audiowatermarksettings-nielsenwatermarkssettings

AutomaticInputFailoverSettingsProperty

class CfnChannel.AutomaticInputFailoverSettingsProperty(*, error_clear_time_msec=None, failover_conditions=None, input_preference=None, secondary_input_id=None)

Bases: object

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.

Parameters:

error_clear_time_msec (Union[int, float, None]) – 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.
failover_conditions (Union[IResolvable, Sequence[Union[IResolvable, FailoverConditionProperty, Dict[str, Any]]], None]) – A list of failover conditions. If any of these conditions occur, MediaLive will perform a failover to the other input.
input_preference (Optional[str]) – Input preference when deciding which input to make active when a previously failed input has recovered.
secondary_input_id (Optional[str]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

automatic_input_failover_settings_property = medialive.CfnChannel.AutomaticInputFailoverSettingsProperty(
    error_clear_time_msec=123,
    failover_conditions=[medialive.CfnChannel.FailoverConditionProperty(
        failover_condition_settings=medialive.CfnChannel.FailoverConditionSettingsProperty(
            audio_silence_settings=medialive.CfnChannel.AudioSilenceFailoverSettingsProperty(
                audio_selector_name="audioSelectorName",
                audio_silence_threshold_msec=123
            ),
            input_loss_settings=medialive.CfnChannel.InputLossFailoverSettingsProperty(
                input_loss_threshold_msec=123
            ),
            video_black_settings=medialive.CfnChannel.VideoBlackFailoverSettingsProperty(
                black_detect_threshold=123,
                video_black_threshold_msec=123
            )
        )
    )],
    input_preference="inputPreference",
    secondary_input_id="secondaryInputId"
)

Attributes

error_clear_time_msec

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

failover_conditions

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

input_preference

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

secondary_input_id

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

AvailBlankingProperty

class CfnChannel.AvailBlankingProperty(*, avail_blanking_image=None, state=None)

Bases: object

The configuration of ad avail blanking in the output.

The parent of this entity is EncoderSettings.

Parameters:

avail_blanking_image (Union[IResolvable, InputLocationProperty, Dict[str, Any], None]) – The blanking image to be used. Keep empty for solid black. Only .bmp and .png images are supported.
state (Optional[str]) – When set to enabled, the video, audio, and captions are blanked when insertion metadata is added.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-availblanking.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

avail_blanking_property = medialive.CfnChannel.AvailBlankingProperty(
    avail_blanking_image=medialive.CfnChannel.InputLocationProperty(
        password_param="passwordParam",
        uri="uri",
        username="username"
    ),
    state="state"
)

Attributes

avail_blanking_image

The blanking image to be used.

Keep empty for solid black. Only .bmp and .png images are supported.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-availblanking.html#cfn-medialive-channel-availblanking-availblankingimage

state

When set to enabled, the video, audio, and captions are blanked when insertion metadata is added.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-availblanking.html#cfn-medialive-channel-availblanking-state

AvailConfigurationProperty

class CfnChannel.AvailConfigurationProperty(*, avail_settings=None, scte35_segmentation_scope=None)

Bases: object

The setup of ad avail handling in the output.

The parent of this entity is EncoderSettings.

Parameters:

avail_settings (Union[IResolvable, AvailSettingsProperty, Dict[str, Any], None]) – The setup of ad avail handling in the output.
scte35_segmentation_scope (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-availconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

avail_configuration_property = medialive.CfnChannel.AvailConfigurationProperty(
    avail_settings=medialive.CfnChannel.AvailSettingsProperty(
        esam=medialive.CfnChannel.EsamProperty(
            acquisition_point_id="acquisitionPointId",
            ad_avail_offset=123,
            password_param="passwordParam",
            pois_endpoint="poisEndpoint",
            username="username",
            zone_identity="zoneIdentity"
        ),
        scte35_splice_insert=medialive.CfnChannel.Scte35SpliceInsertProperty(
            ad_avail_offset=123,
            no_regional_blackout_flag="noRegionalBlackoutFlag",
            web_delivery_allowed_flag="webDeliveryAllowedFlag"
        ),
        scte35_time_signal_apos=medialive.CfnChannel.Scte35TimeSignalAposProperty(
            ad_avail_offset=123,
            no_regional_blackout_flag="noRegionalBlackoutFlag",
            web_delivery_allowed_flag="webDeliveryAllowedFlag"
        )
    ),
    scte35_segmentation_scope="scte35SegmentationScope"
)

Attributes

avail_settings

The setup of ad avail handling in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-availconfiguration.html#cfn-medialive-channel-availconfiguration-availsettings

scte35_segmentation_scope

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-availconfiguration.html#cfn-medialive-channel-availconfiguration-scte35segmentationscope

Type:: see

AvailSettingsProperty

class CfnChannel.AvailSettingsProperty(*, esam=None, scte35_splice_insert=None, scte35_time_signal_apos=None)

Bases: object

The settings for the ad avail setup in the output.

The parent of this entity is AvailConfiguration.

Parameters:

esam (Union[IResolvable, EsamProperty, Dict[str, Any], None]) –
scte35_splice_insert (Union[IResolvable, Scte35SpliceInsertProperty, Dict[str, Any], None]) – The setup for SCTE-35 splice insert handling.
scte35_time_signal_apos (Union[IResolvable, Scte35TimeSignalAposProperty, Dict[str, Any], None]) – The setup for SCTE-35 time signal APOS handling.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-availsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

avail_settings_property = medialive.CfnChannel.AvailSettingsProperty(
    esam=medialive.CfnChannel.EsamProperty(
        acquisition_point_id="acquisitionPointId",
        ad_avail_offset=123,
        password_param="passwordParam",
        pois_endpoint="poisEndpoint",
        username="username",
        zone_identity="zoneIdentity"
    ),
    scte35_splice_insert=medialive.CfnChannel.Scte35SpliceInsertProperty(
        ad_avail_offset=123,
        no_regional_blackout_flag="noRegionalBlackoutFlag",
        web_delivery_allowed_flag="webDeliveryAllowedFlag"
    ),
    scte35_time_signal_apos=medialive.CfnChannel.Scte35TimeSignalAposProperty(
        ad_avail_offset=123,
        no_regional_blackout_flag="noRegionalBlackoutFlag",
        web_delivery_allowed_flag="webDeliveryAllowedFlag"
    )
)

Attributes

esam

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-availsettings.html#cfn-medialive-channel-availsettings-esam

Type:: see

scte35_splice_insert

The setup for SCTE-35 splice insert handling.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-availsettings.html#cfn-medialive-channel-availsettings-scte35spliceinsert

scte35_time_signal_apos

The setup for SCTE-35 time signal APOS handling.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-availsettings.html#cfn-medialive-channel-availsettings-scte35timesignalapos

BlackoutSlateProperty

class CfnChannel.BlackoutSlateProperty(*, blackout_slate_image=None, network_end_blackout=None, network_end_blackout_image=None, network_id=None, state=None)

Bases: object

The settings for a blackout slate.

The parent of this entity is EncoderSettings.

Parameters:

blackout_slate_image (Union[IResolvable, InputLocationProperty, Dict[str, Any], None]) – The blackout slate image to be used. Keep empty for solid black. Only .bmp and .png images are supported.
network_end_blackout (Optional[str]) – Setting to enabled causes MediaLive to blackout the video, audio, and captions, and raise the “Network Blackout Image” slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout is lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in Network ID.
network_end_blackout_image (Union[IResolvable, InputLocationProperty, Dict[str, Any], None]) – The path to the local file to use as the Network End Blackout image. The image is scaled to fill the entire output raster.
network_id (Optional[str]) – Provides a Network ID that matches EIDR ID format (for example, “10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C”).
state (Optional[str]) – When set to enabled, this causes video, audio, and captions to be blanked when indicated by program metadata.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-blackoutslate.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

blackout_slate_property = medialive.CfnChannel.BlackoutSlateProperty(
    blackout_slate_image=medialive.CfnChannel.InputLocationProperty(
        password_param="passwordParam",
        uri="uri",
        username="username"
    ),
    network_end_blackout="networkEndBlackout",
    network_end_blackout_image=medialive.CfnChannel.InputLocationProperty(
        password_param="passwordParam",
        uri="uri",
        username="username"
    ),
    network_id="networkId",
    state="state"
)

Attributes

blackout_slate_image

The blackout slate image to be used.

Keep empty for solid black. Only .bmp and .png images are supported.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-blackoutslate.html#cfn-medialive-channel-blackoutslate-blackoutslateimage

network_end_blackout

Setting to enabled causes MediaLive to blackout the video, audio, and captions, and raise the “Network Blackout Image” slate when an SCTE104/35 Network End Segmentation Descriptor is encountered.

The blackout is lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in Network ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-blackoutslate.html#cfn-medialive-channel-blackoutslate-networkendblackout

network_end_blackout_image

The path to the local file to use as the Network End Blackout image.

The image is scaled to fill the entire output raster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-blackoutslate.html#cfn-medialive-channel-blackoutslate-networkendblackoutimage

network_id

Provides a Network ID that matches EIDR ID format (for example, “10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C”).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-blackoutslate.html#cfn-medialive-channel-blackoutslate-networkid

state

When set to enabled, this causes video, audio, and captions to be blanked when indicated by program metadata.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-blackoutslate.html#cfn-medialive-channel-blackoutslate-state

BurnInDestinationSettingsProperty

class CfnChannel.BurnInDestinationSettingsProperty(*, alignment=None, background_color=None, background_opacity=None, font=None, font_color=None, font_opacity=None, font_resolution=None, font_size=None, outline_color=None, outline_size=None, shadow_color=None, shadow_opacity=None, shadow_x_offset=None, shadow_y_offset=None, teletext_grid_control=None, x_position=None, y_position=None)

Bases: object

The settings for burn-in captions in the output.

The parent of this entity is CaptionDestinationSettings.

Parameters:

alignment (Optional[str]) – If no explicit xPosition or yPosition is provided, setting alignment to centered places the captions at the bottom center of the output. Similarly, setting a left alignment aligns captions to the bottom left of the output. If x and y positions are specified in conjunction with the alignment parameter, the font is justified (either left or centered) relative to those coordinates. Selecting “smart” justification left-justifies live subtitles and center-justifies pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.
background_color (Optional[str]) – Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
background_opacity (Union[int, float, None]) – Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
font (Union[IResolvable, InputLocationProperty, Dict[str, Any], None]) – The external font file that is used for captions burn-in. The file extension must be .ttf or .tte. Although you can select output fonts for many different types of input captions, embedded, STL, and Teletext sources use a strict grid system. Using external fonts with these captions sources could cause an unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
font_color (Optional[str]) – Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded, or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.
font_opacity (Union[int, float, None]) – Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
font_resolution (Union[int, float, None]) – The font resolution in DPI (dots per inch). The default is 96 dpi. All burn-in and DVB-Sub font settings must match.
font_size (Optional[str]) – When set to auto, fontSize scales depending on the size of the output. Providing a positive integer specifies the exact font size in points. All burn-in and DVB-Sub font settings must match.
outline_color (Optional[str]) – Specifies the font outline color. This option is not valid for source captions that are either 608/embedded or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.
outline_size (Union[int, float, None]) – Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.
shadow_color (Optional[str]) – Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
shadow_opacity (Union[int, float, None]) – Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
shadow_x_offset (Union[int, float, None]) – Specifies the horizontal offset of the shadow that is relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
shadow_y_offset (Union[int, float, None]) – Specifies the vertical offset of the shadow that is relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
teletext_grid_control (Optional[str]) – Controls whether a fixed grid size is used to generate the output subtitles bitmap. This applies only to Teletext inputs and DVB-Sub/Burn-in outputs.
x_position (Union[int, float, None]) – Specifies the horizontal position of the captions relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal captions position is determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
y_position (Union[int, float, None]) – Specifies the vertical position of the captions relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the captions are positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

burn_in_destination_settings_property = medialive.CfnChannel.BurnInDestinationSettingsProperty(
    alignment="alignment",
    background_color="backgroundColor",
    background_opacity=123,
    font=medialive.CfnChannel.InputLocationProperty(
        password_param="passwordParam",
        uri="uri",
        username="username"
    ),
    font_color="fontColor",
    font_opacity=123,
    font_resolution=123,
    font_size="fontSize",
    outline_color="outlineColor",
    outline_size=123,
    shadow_color="shadowColor",
    shadow_opacity=123,
    shadow_xOffset=123,
    shadow_yOffset=123,
    teletext_grid_control="teletextGridControl",
    x_position=123,
    y_position=123
)

Attributes

alignment

If no explicit xPosition or yPosition is provided, setting alignment to centered places the captions at the bottom center of the output.

Similarly, setting a left alignment aligns captions to the bottom left of the output. If x and y positions are specified in conjunction with the alignment parameter, the font is justified (either left or centered) relative to those coordinates. Selecting “smart” justification left-justifies live subtitles and center-justifies pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-alignment

background_color

Specifies the color of the rectangle behind the captions.

All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-backgroundcolor

background_opacity

Specifies the opacity of the background rectangle.

255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-backgroundopacity

font

The external font file that is used for captions burn-in.

The file extension must be .ttf or .tte. Although you can select output fonts for many different types of input captions, embedded, STL, and Teletext sources use a strict grid system. Using external fonts with these captions sources could cause an unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-font

font_color

Specifies the color of the burned-in captions.

This option is not valid for source captions that are STL, 608/embedded, or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-fontcolor

font_opacity

Specifies the opacity of the burned-in captions.

255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-fontopacity

font_resolution

The font resolution in DPI (dots per inch).

The default is 96 dpi. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-fontresolution

font_size

When set to auto, fontSize scales depending on the size of the output.

Providing a positive integer specifies the exact font size in points. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-fontsize

outline_color

Specifies the font outline color.

This option is not valid for source captions that are either 608/embedded or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-outlinecolor

outline_size

Specifies font outline size in pixels.

This option is not valid for source captions that are either 608/embedded or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-outlinesize

shadow_color

Specifies the color of the shadow cast by the captions.

All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-shadowcolor

shadow_opacity

Specifies the opacity of the shadow.

255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-shadowopacity

shadow_x_offset

Specifies the horizontal offset of the shadow that is relative to the captions in pixels.

A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-shadowxoffset

shadow_y_offset

Specifies the vertical offset of the shadow that is relative to the captions in pixels.

A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-shadowyoffset

teletext_grid_control

Controls whether a fixed grid size is used to generate the output subtitles bitmap.

This applies only to Teletext inputs and DVB-Sub/Burn-in outputs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-teletextgridcontrol

x_position

Specifies the horizontal position of the captions relative to the left side of the output in pixels.

A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal captions position is determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-xposition

y_position

Specifies the vertical position of the captions relative to the top of the output in pixels.

A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the captions are positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-burnindestinationsettings.html#cfn-medialive-channel-burnindestinationsettings-yposition

CaptionDescriptionProperty

class CfnChannel.CaptionDescriptionProperty(*, accessibility=None, caption_dash_roles=None, caption_selector_name=None, destination_settings=None, dvb_dash_accessibility=None, language_code=None, language_description=None, name=None)

Bases: object

The encoding information for output captions.

The parent of this entity is EncoderSettings.

Parameters:

accessibility (Optional[str]) –
caption_dash_roles (Optional[Sequence[str]]) –
caption_selector_name (Optional[str]) – Specifies which input captions selector to use as a captions source when generating output captions. This field should match a captionSelector name.
destination_settings (Union[IResolvable, CaptionDestinationSettingsProperty, Dict[str, Any], None]) – Additional settings for a captions destination that depend on the destination type.
dvb_dash_accessibility (Optional[str]) –
language_code (Optional[str]) – An ISO 639-2 three-digit code. For more information, see http://www.loc.gov/standards/iso639-2/.
language_description (Optional[str]) – Human-readable information to indicate the captions that are available for players (for example, English or Spanish).
name (Optional[str]) – The name of the captions description. The name is used to associate a captions description with an output. Names must be unique within a channel.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

caption_description_property = medialive.CfnChannel.CaptionDescriptionProperty(
    accessibility="accessibility",
    caption_dash_roles=["captionDashRoles"],
    caption_selector_name="captionSelectorName",
    destination_settings=medialive.CfnChannel.CaptionDestinationSettingsProperty(
        arib_destination_settings=medialive.CfnChannel.AribDestinationSettingsProperty(),
        burn_in_destination_settings=medialive.CfnChannel.BurnInDestinationSettingsProperty(
            alignment="alignment",
            background_color="backgroundColor",
            background_opacity=123,
            font=medialive.CfnChannel.InputLocationProperty(
                password_param="passwordParam",
                uri="uri",
                username="username"
            ),
            font_color="fontColor",
            font_opacity=123,
            font_resolution=123,
            font_size="fontSize",
            outline_color="outlineColor",
            outline_size=123,
            shadow_color="shadowColor",
            shadow_opacity=123,
            shadow_xOffset=123,
            shadow_yOffset=123,
            teletext_grid_control="teletextGridControl",
            x_position=123,
            y_position=123
        ),
        dvb_sub_destination_settings=medialive.CfnChannel.DvbSubDestinationSettingsProperty(
            alignment="alignment",
            background_color="backgroundColor",
            background_opacity=123,
            font=medialive.CfnChannel.InputLocationProperty(
                password_param="passwordParam",
                uri="uri",
                username="username"
            ),
            font_color="fontColor",
            font_opacity=123,
            font_resolution=123,
            font_size="fontSize",
            outline_color="outlineColor",
            outline_size=123,
            shadow_color="shadowColor",
            shadow_opacity=123,
            shadow_xOffset=123,
            shadow_yOffset=123,
            teletext_grid_control="teletextGridControl",
            x_position=123,
            y_position=123
        ),
        ebu_tt_dDestination_settings=medialive.CfnChannel.EbuTtDDestinationSettingsProperty(
            copyright_holder="copyrightHolder",
            fill_line_gap="fillLineGap",
            font_family="fontFamily",
            style_control="styleControl"
        ),
        embedded_destination_settings=medialive.CfnChannel.EmbeddedDestinationSettingsProperty(),
        embedded_plus_scte20_destination_settings=medialive.CfnChannel.EmbeddedPlusScte20DestinationSettingsProperty(),
        rtmp_caption_info_destination_settings=medialive.CfnChannel.RtmpCaptionInfoDestinationSettingsProperty(),
        scte20_plus_embedded_destination_settings=medialive.CfnChannel.Scte20PlusEmbeddedDestinationSettingsProperty(),
        scte27_destination_settings=medialive.CfnChannel.Scte27DestinationSettingsProperty(),
        smpte_tt_destination_settings=medialive.CfnChannel.SmpteTtDestinationSettingsProperty(),
        teletext_destination_settings=medialive.CfnChannel.TeletextDestinationSettingsProperty(),
        ttml_destination_settings=medialive.CfnChannel.TtmlDestinationSettingsProperty(
            style_control="styleControl"
        ),
        webvtt_destination_settings=medialive.CfnChannel.WebvttDestinationSettingsProperty(
            style_control="styleControl"
        )
    ),
    dvb_dash_accessibility="dvbDashAccessibility",
    language_code="languageCode",
    language_description="languageDescription",
    name="name"
)

Attributes

accessibility

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-accessibility

Type:: see

caption_dash_roles

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-captiondashroles

Type:: see

caption_selector_name

Specifies which input captions selector to use as a captions source when generating output captions.

This field should match a captionSelector name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-captionselectorname

destination_settings

Additional settings for a captions destination that depend on the destination type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-destinationsettings

dvb_dash_accessibility

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-dvbdashaccessibility

Type:: see

language_code

An ISO 639-2 three-digit code.

For more information, see http://www.loc.gov/standards/iso639-2/.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-languagecode

language_description

Human-readable information to indicate the captions that are available for players (for example, English or Spanish).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-languagedescription

name

The name of the captions description.

The name is used to associate a captions description with an output. Names must be unique within a channel.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondescription.html#cfn-medialive-channel-captiondescription-name

CaptionDestinationSettingsProperty

class CfnChannel.CaptionDestinationSettingsProperty(*, arib_destination_settings=None, burn_in_destination_settings=None, dvb_sub_destination_settings=None, ebu_tt_d_destination_settings=None, embedded_destination_settings=None, embedded_plus_scte20_destination_settings=None, rtmp_caption_info_destination_settings=None, scte20_plus_embedded_destination_settings=None, scte27_destination_settings=None, smpte_tt_destination_settings=None, teletext_destination_settings=None, ttml_destination_settings=None, webvtt_destination_settings=None)

Bases: object

The configuration of one captions encode in the output.

The parent of this entity is CaptionDescription.

Parameters:

arib_destination_settings (Union[IResolvable, AribDestinationSettingsProperty, Dict[str, Any], None]) – The configuration of one ARIB captions encode in the output.
burn_in_destination_settings (Union[IResolvable, BurnInDestinationSettingsProperty, Dict[str, Any], None]) – The configuration of one burn-in captions encode in the output.
dvb_sub_destination_settings (Union[IResolvable, DvbSubDestinationSettingsProperty, Dict[str, Any], None]) – The configuration of one DVB Sub captions encode in the output.
ebu_tt_d_destination_settings (Union[IResolvable, EbuTtDDestinationSettingsProperty, Dict[str, Any], None]) – Settings for EBU-TT captions in the output.
embedded_destination_settings (Union[IResolvable, EmbeddedDestinationSettingsProperty, Dict[str, Any], None]) – The configuration of one embedded captions encode in the output.
embedded_plus_scte20_destination_settings (Union[IResolvable, EmbeddedPlusScte20DestinationSettingsProperty, Dict[str, Any], None]) – The configuration of one embedded plus SCTE-20 captions encode in the output.
rtmp_caption_info_destination_settings (Union[IResolvable, RtmpCaptionInfoDestinationSettingsProperty, Dict[str, Any], None]) – The configuration of one RTMPCaptionInfo captions encode in the output.
scte20_plus_embedded_destination_settings (Union[IResolvable, Scte20PlusEmbeddedDestinationSettingsProperty, Dict[str, Any], None]) – The configuration of one SCTE20 plus embedded captions encode in the output.
scte27_destination_settings (Union[IResolvable, Scte27DestinationSettingsProperty, Dict[str, Any], None]) – The configuration of one SCTE-27 captions encode in the output.
smpte_tt_destination_settings (Union[IResolvable, SmpteTtDestinationSettingsProperty, Dict[str, Any], None]) – The configuration of one SMPTE-TT captions encode in the output.
teletext_destination_settings (Union[IResolvable, TeletextDestinationSettingsProperty, Dict[str, Any], None]) – The configuration of one Teletext captions encode in the output.
ttml_destination_settings (Union[IResolvable, TtmlDestinationSettingsProperty, Dict[str, Any], None]) – The configuration of one TTML captions encode in the output.
webvtt_destination_settings (Union[IResolvable, WebvttDestinationSettingsProperty, Dict[str, Any], None]) – The configuration of one WebVTT captions encode in the output.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondestinationsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

caption_destination_settings_property = medialive.CfnChannel.CaptionDestinationSettingsProperty(
    arib_destination_settings=medialive.CfnChannel.AribDestinationSettingsProperty(),
    burn_in_destination_settings=medialive.CfnChannel.BurnInDestinationSettingsProperty(
        alignment="alignment",
        background_color="backgroundColor",
        background_opacity=123,
        font=medialive.CfnChannel.InputLocationProperty(
            password_param="passwordParam",
            uri="uri",
            username="username"
        ),
        font_color="fontColor",
        font_opacity=123,
        font_resolution=123,
        font_size="fontSize",
        outline_color="outlineColor",
        outline_size=123,
        shadow_color="shadowColor",
        shadow_opacity=123,
        shadow_xOffset=123,
        shadow_yOffset=123,
        teletext_grid_control="teletextGridControl",
        x_position=123,
        y_position=123
    ),
    dvb_sub_destination_settings=medialive.CfnChannel.DvbSubDestinationSettingsProperty(
        alignment="alignment",
        background_color="backgroundColor",
        background_opacity=123,
        font=medialive.CfnChannel.InputLocationProperty(
            password_param="passwordParam",
            uri="uri",
            username="username"
        ),
        font_color="fontColor",
        font_opacity=123,
        font_resolution=123,
        font_size="fontSize",
        outline_color="outlineColor",
        outline_size=123,
        shadow_color="shadowColor",
        shadow_opacity=123,
        shadow_xOffset=123,
        shadow_yOffset=123,
        teletext_grid_control="teletextGridControl",
        x_position=123,
        y_position=123
    ),
    ebu_tt_dDestination_settings=medialive.CfnChannel.EbuTtDDestinationSettingsProperty(
        copyright_holder="copyrightHolder",
        fill_line_gap="fillLineGap",
        font_family="fontFamily",
        style_control="styleControl"
    ),
    embedded_destination_settings=medialive.CfnChannel.EmbeddedDestinationSettingsProperty(),
    embedded_plus_scte20_destination_settings=medialive.CfnChannel.EmbeddedPlusScte20DestinationSettingsProperty(),
    rtmp_caption_info_destination_settings=medialive.CfnChannel.RtmpCaptionInfoDestinationSettingsProperty(),
    scte20_plus_embedded_destination_settings=medialive.CfnChannel.Scte20PlusEmbeddedDestinationSettingsProperty(),
    scte27_destination_settings=medialive.CfnChannel.Scte27DestinationSettingsProperty(),
    smpte_tt_destination_settings=medialive.CfnChannel.SmpteTtDestinationSettingsProperty(),
    teletext_destination_settings=medialive.CfnChannel.TeletextDestinationSettingsProperty(),
    ttml_destination_settings=medialive.CfnChannel.TtmlDestinationSettingsProperty(
        style_control="styleControl"
    ),
    webvtt_destination_settings=medialive.CfnChannel.WebvttDestinationSettingsProperty(
        style_control="styleControl"
    )
)

Attributes

arib_destination_settings

The configuration of one ARIB captions encode in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondestinationsettings.html#cfn-medialive-channel-captiondestinationsettings-aribdestinationsettings

burn_in_destination_settings

The configuration of one burn-in captions encode in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondestinationsettings.html#cfn-medialive-channel-captiondestinationsettings-burnindestinationsettings

dvb_sub_destination_settings

The configuration of one DVB Sub captions encode in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondestinationsettings.html#cfn-medialive-channel-captiondestinationsettings-dvbsubdestinationsettings

ebu_tt_d_destination_settings

Settings for EBU-TT captions in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondestinationsettings.html#cfn-medialive-channel-captiondestinationsettings-ebuttddestinationsettings

embedded_destination_settings

The configuration of one embedded captions encode in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondestinationsettings.html#cfn-medialive-channel-captiondestinationsettings-embeddeddestinationsettings

embedded_plus_scte20_destination_settings

The configuration of one embedded plus SCTE-20 captions encode in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondestinationsettings.html#cfn-medialive-channel-captiondestinationsettings-embeddedplusscte20destinationsettings

rtmp_caption_info_destination_settings

The configuration of one RTMPCaptionInfo captions encode in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondestinationsettings.html#cfn-medialive-channel-captiondestinationsettings-rtmpcaptioninfodestinationsettings

scte20_plus_embedded_destination_settings

The configuration of one SCTE20 plus embedded captions encode in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondestinationsettings.html#cfn-medialive-channel-captiondestinationsettings-scte20plusembeddeddestinationsettings

scte27_destination_settings

The configuration of one SCTE-27 captions encode in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondestinationsettings.html#cfn-medialive-channel-captiondestinationsettings-scte27destinationsettings

smpte_tt_destination_settings

The configuration of one SMPTE-TT captions encode in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondestinationsettings.html#cfn-medialive-channel-captiondestinationsettings-smptettdestinationsettings

teletext_destination_settings

The configuration of one Teletext captions encode in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondestinationsettings.html#cfn-medialive-channel-captiondestinationsettings-teletextdestinationsettings

ttml_destination_settings

The configuration of one TTML captions encode in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondestinationsettings.html#cfn-medialive-channel-captiondestinationsettings-ttmldestinationsettings

webvtt_destination_settings

The configuration of one WebVTT captions encode in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captiondestinationsettings.html#cfn-medialive-channel-captiondestinationsettings-webvttdestinationsettings

CaptionLanguageMappingProperty

class CfnChannel.CaptionLanguageMappingProperty(*, caption_channel=None, language_code=None, language_description=None)

Bases: object

Maps a captions channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.

The parent of this entity is HlsGroupSettings.

Parameters:

caption_channel (Union[int, float, None]) – The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4).
language_code (Optional[str]) – A three-character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2).
language_description (Optional[str]) – The textual description of language.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionlanguagemapping.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

caption_language_mapping_property = medialive.CfnChannel.CaptionLanguageMappingProperty(
    caption_channel=123,
    language_code="languageCode",
    language_description="languageDescription"
)

Attributes

caption_channel

The closed caption channel being described by this CaptionLanguageMapping.

Each channel mapping must have a unique channel number (maximum of 4).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionlanguagemapping.html#cfn-medialive-channel-captionlanguagemapping-captionchannel

language_code

//www.loc.gov/standards/iso639-2).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionlanguagemapping.html#cfn-medialive-channel-captionlanguagemapping-languagecode
Type:: A three-character ISO 639-2 language code (see http

language_description

The textual description of language.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionlanguagemapping.html#cfn-medialive-channel-captionlanguagemapping-languagedescription

CaptionRectangleProperty

class CfnChannel.CaptionRectangleProperty(*, height=None, left_offset=None, top_offset=None, width=None)

Bases: object

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.

Parameters:

height (Union[int, float, None]) – 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:extent - Y in the TTML standard.
left_offset (Union[int, float, None]) – Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don’t have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages. If you specify a value for one of these fields, you must specify a value for all of them. For leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, “10” means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame. This field corresponds to tts:origin - X in the TTML standard.
top_offset (Union[int, float, None]) – See the description in leftOffset. For topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, “10” means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame. This field corresponds to tts:origin - Y in the TTML standard.
width (Union[int, float, None]) – See the description in leftOffset. For width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, “80” means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less. This field corresponds to tts:extent - X in the TTML standard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionrectangle.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

caption_rectangle_property = medialive.CfnChannel.CaptionRectangleProperty(
    height=123,
    left_offset=123,
    top_offset=123,
    width=123
)

Attributes

height

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:extent - Y in the TTML standard.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionrectangle.html#cfn-medialive-channel-captionrectangle-height

left_offset

Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output.

(Make sure to leave the default if you don’t have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages. If you specify a value for one of these fields, you must specify a value for all of them.

For leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, “10” means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame. This field corresponds to tts:origin - X in the TTML standard.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionrectangle.html#cfn-medialive-channel-captionrectangle-leftoffset

top_offset

See the description in leftOffset.

For topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, “10” means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame. This field corresponds to tts:origin - Y in the TTML standard.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionrectangle.html#cfn-medialive-channel-captionrectangle-topoffset

width

See the description in leftOffset.

For width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, “80” means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less. This field corresponds to tts:extent - X in the TTML standard.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionrectangle.html#cfn-medialive-channel-captionrectangle-width

CaptionSelectorProperty

class CfnChannel.CaptionSelectorProperty(*, language_code=None, name=None, selector_settings=None)

Bases: object

Information about one caption to extract from the input.

The parent of this entity is InputSettings.

Parameters:

language_code (Optional[str]) – When specified, this field indicates the three-letter language code of the captions track to extract from the source.
name (Optional[str]) – 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.
selector_settings (Union[IResolvable, CaptionSelectorSettingsProperty, Dict[str, Any], None]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

caption_selector_property = medialive.CfnChannel.CaptionSelectorProperty(
    language_code="languageCode",
    name="name",
    selector_settings=medialive.CfnChannel.CaptionSelectorSettingsProperty(
        ancillary_source_settings=medialive.CfnChannel.AncillarySourceSettingsProperty(
            source_ancillary_channel_number=123
        ),
        arib_source_settings=medialive.CfnChannel.AribSourceSettingsProperty(),
        dvb_sub_source_settings=medialive.CfnChannel.DvbSubSourceSettingsProperty(
            ocr_language="ocrLanguage",
            pid=123
        ),
        embedded_source_settings=medialive.CfnChannel.EmbeddedSourceSettingsProperty(
            convert608_to708="convert608To708",
            scte20_detection="scte20Detection",
            source608_channel_number=123,
            source608_track_number=123
        ),
        scte20_source_settings=medialive.CfnChannel.Scte20SourceSettingsProperty(
            convert608_to708="convert608To708",
            source608_channel_number=123
        ),
        scte27_source_settings=medialive.CfnChannel.Scte27SourceSettingsProperty(
            ocr_language="ocrLanguage",
            pid=123
        ),
        teletext_source_settings=medialive.CfnChannel.TeletextSourceSettingsProperty(
            output_rectangle=medialive.CfnChannel.CaptionRectangleProperty(
                height=123,
                left_offset=123,
                top_offset=123,
                width=123
            ),
            page_number="pageNumber"
        )
    )
)

Attributes

language_code

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

name

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

selector_settings

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

CaptionSelectorSettingsProperty

class CfnChannel.CaptionSelectorSettingsProperty(*, ancillary_source_settings=None, arib_source_settings=None, dvb_sub_source_settings=None, embedded_source_settings=None, scte20_source_settings=None, scte27_source_settings=None, teletext_source_settings=None)

Bases: object

Captions Selector Settings.

The parent of this entity is CaptionSelector.

Parameters:

ancillary_source_settings (Union[IResolvable, AncillarySourceSettingsProperty, Dict[str, Any], None]) – Information about the ancillary captions to extract from the input.
arib_source_settings (Union[IResolvable, AribSourceSettingsProperty, Dict[str, Any], None]) – Information about the ARIB captions to extract from the input.
dvb_sub_source_settings (Union[IResolvable, DvbSubSourceSettingsProperty, Dict[str, Any], None]) – Information about the DVB Sub captions to extract from the input.
embedded_source_settings (Union[IResolvable, EmbeddedSourceSettingsProperty, Dict[str, Any], None]) – Information about the embedded captions to extract from the input.
scte20_source_settings (Union[IResolvable, Scte20SourceSettingsProperty, Dict[str, Any], None]) – Information about the SCTE-20 captions to extract from the input.
scte27_source_settings (Union[IResolvable, Scte27SourceSettingsProperty, Dict[str, Any], None]) – Information about the SCTE-27 captions to extract from the input.
teletext_source_settings (Union[IResolvable, TeletextSourceSettingsProperty, Dict[str, Any], None]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

caption_selector_settings_property = medialive.CfnChannel.CaptionSelectorSettingsProperty(
    ancillary_source_settings=medialive.CfnChannel.AncillarySourceSettingsProperty(
        source_ancillary_channel_number=123
    ),
    arib_source_settings=medialive.CfnChannel.AribSourceSettingsProperty(),
    dvb_sub_source_settings=medialive.CfnChannel.DvbSubSourceSettingsProperty(
        ocr_language="ocrLanguage",
        pid=123
    ),
    embedded_source_settings=medialive.CfnChannel.EmbeddedSourceSettingsProperty(
        convert608_to708="convert608To708",
        scte20_detection="scte20Detection",
        source608_channel_number=123,
        source608_track_number=123
    ),
    scte20_source_settings=medialive.CfnChannel.Scte20SourceSettingsProperty(
        convert608_to708="convert608To708",
        source608_channel_number=123
    ),
    scte27_source_settings=medialive.CfnChannel.Scte27SourceSettingsProperty(
        ocr_language="ocrLanguage",
        pid=123
    ),
    teletext_source_settings=medialive.CfnChannel.TeletextSourceSettingsProperty(
        output_rectangle=medialive.CfnChannel.CaptionRectangleProperty(
            height=123,
            left_offset=123,
            top_offset=123,
            width=123
        ),
        page_number="pageNumber"
    )
)

Attributes

ancillary_source_settings

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

arib_source_settings

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

dvb_sub_source_settings

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

embedded_source_settings

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

scte20_source_settings

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

scte27_source_settings

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

teletext_source_settings

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

CdiInputSpecificationProperty

class CfnChannel.CdiInputSpecificationProperty(*, resolution=None)

Bases: object

The input specification for this channel.

It specifies the key characteristics of CDI inputs for this channel, when those characteristics are different from other inputs.

This entity is at the top level in the channel.

Parameters:: resolution (Optional[str]) – Maximum CDI input resolution.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-cdiinputspecification.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

cdi_input_specification_property = medialive.CfnChannel.CdiInputSpecificationProperty(
    resolution="resolution"
)

Attributes

resolution

Maximum CDI input resolution.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-cdiinputspecification.html#cfn-medialive-channel-cdiinputspecification-resolution

CmafIngestGroupSettingsProperty

class CfnChannel.CmafIngestGroupSettingsProperty(*, destination=None, nielsen_id3_behavior=None, scte35_type=None, segment_length=None, segment_length_units=None, send_delay_ms=None)

Bases: object

Parameters:

destination (Union[IResolvable, OutputLocationRefProperty, Dict[str, Any], None]) –
nielsen_id3_behavior (Optional[str]) –
scte35_type (Optional[str]) –
segment_length (Union[int, float, None]) –
segment_length_units (Optional[str]) –
send_delay_ms (Union[int, float, None]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-cmafingestgroupsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

cmaf_ingest_group_settings_property = medialive.CfnChannel.CmafIngestGroupSettingsProperty(
    destination=medialive.CfnChannel.OutputLocationRefProperty(
        destination_ref_id="destinationRefId"
    ),
    nielsen_id3_behavior="nielsenId3Behavior",
    scte35_type="scte35Type",
    segment_length=123,
    segment_length_units="segmentLengthUnits",
    send_delay_ms=123
)

Attributes

destination

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-cmafingestgroupsettings.html#cfn-medialive-channel-cmafingestgroupsettings-destination

Type:: see

nielsen_id3_behavior

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-cmafingestgroupsettings.html#cfn-medialive-channel-cmafingestgroupsettings-nielsenid3behavior

Type:: see

scte35_type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-cmafingestgroupsettings.html#cfn-medialive-channel-cmafingestgroupsettings-scte35type

Type:: see

segment_length

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-cmafingestgroupsettings.html#cfn-medialive-channel-cmafingestgroupsettings-segmentlength

Type:: see

segment_length_units

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-cmafingestgroupsettings.html#cfn-medialive-channel-cmafingestgroupsettings-segmentlengthunits

Type:: see

send_delay_ms

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-cmafingestgroupsettings.html#cfn-medialive-channel-cmafingestgroupsettings-senddelayms

Type:: see

CmafIngestOutputSettingsProperty

class CfnChannel.CmafIngestOutputSettingsProperty(*, name_modifier=None)

Bases: object

Parameters:: name_modifier (Optional[str]) –
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-cmafingestoutputsettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

cmaf_ingest_output_settings_property = medialive.CfnChannel.CmafIngestOutputSettingsProperty(
    name_modifier="nameModifier"
)

Attributes

name_modifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-cmafingestoutputsettings.html#cfn-medialive-channel-cmafingestoutputsettings-namemodifier

Type:: see

ColorCorrectionProperty

class CfnChannel.ColorCorrectionProperty(*, input_color_space=None, output_color_space=None, uri=None)

Bases: object

Parameters:

input_color_space (Optional[str]) –
output_color_space (Optional[str]) –
uri (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-colorcorrection.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

color_correction_property = medialive.CfnChannel.ColorCorrectionProperty(
    input_color_space="inputColorSpace",
    output_color_space="outputColorSpace",
    uri="uri"
)

Attributes

input_color_space

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-colorcorrection.html#cfn-medialive-channel-colorcorrection-inputcolorspace

Type:: see

output_color_space

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-colorcorrection.html#cfn-medialive-channel-colorcorrection-outputcolorspace

Type:: see

uri

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-colorcorrection.html#cfn-medialive-channel-colorcorrection-uri

Type:: see

ColorCorrectionSettingsProperty

class CfnChannel.ColorCorrectionSettingsProperty(*, global_color_corrections=None)

Bases: object

Parameters:: global_color_corrections (Union[IResolvable, Sequence[Union[IResolvable, ColorCorrectionProperty, Dict[str, Any]]], None]) –
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-colorcorrectionsettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

color_correction_settings_property = medialive.CfnChannel.ColorCorrectionSettingsProperty(
    global_color_corrections=[medialive.CfnChannel.ColorCorrectionProperty(
        input_color_space="inputColorSpace",
        output_color_space="outputColorSpace",
        uri="uri"
    )]
)

Attributes

global_color_corrections

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-colorcorrectionsettings.html#cfn-medialive-channel-colorcorrectionsettings-globalcolorcorrections

Type:: see

ColorSpacePassthroughSettingsProperty

class CfnChannel.ColorSpacePassthroughSettingsProperty

Bases: object

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-colorspacepassthroughsettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

color_space_passthrough_settings_property = medialive.CfnChannel.ColorSpacePassthroughSettingsProperty()

DolbyVision81SettingsProperty

class CfnChannel.DolbyVision81SettingsProperty

Bases: object

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dolbyvision81settings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

dolby_vision81_settings_property = medialive.CfnChannel.DolbyVision81SettingsProperty()

DvbNitSettingsProperty

class CfnChannel.DvbNitSettingsProperty(*, network_id=None, network_name=None, rep_interval=None)

Bases: object

The configuration of DVB NIT.

The parent of this entity is M2tsSettings.

Parameters:

network_id (Union[int, float, None]) – The numeric value placed in the Network Information Table (NIT).
network_name (Optional[str]) – The network name text placed in the networkNameDescriptor inside the Network Information Table (NIT). The maximum length is 256 characters.
rep_interval (Union[int, float, None]) – The number of milliseconds between instances of this table in the output transport stream.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbnitsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

dvb_nit_settings_property = medialive.CfnChannel.DvbNitSettingsProperty(
    network_id=123,
    network_name="networkName",
    rep_interval=123
)

Attributes

network_id

The numeric value placed in the Network Information Table (NIT).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbnitsettings.html#cfn-medialive-channel-dvbnitsettings-networkid

network_name

The network name text placed in the networkNameDescriptor inside the Network Information Table (NIT).

The maximum length is 256 characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbnitsettings.html#cfn-medialive-channel-dvbnitsettings-networkname

rep_interval

The number of milliseconds between instances of this table in the output transport stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbnitsettings.html#cfn-medialive-channel-dvbnitsettings-repinterval

DvbSdtSettingsProperty

class CfnChannel.DvbSdtSettingsProperty(*, output_sdt=None, rep_interval=None, service_name=None, service_provider_name=None)

Bases: object

A DVB Service Description Table (SDT).

The parent of this entity is M2tsSettings.

Parameters:

output_sdt (Optional[str]) – Selects a method of inserting SDT information into an output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input. Otherwise, it falls back on the user-defined values. The sdtManual setting means that the user will enter the SDT information. The sdtNone setting means that the output stream will not contain SDT information.
rep_interval (Union[int, float, None]) – The number of milliseconds between instances of this table in the output transport stream.
service_name (Optional[str]) – The service name placed in the serviceDescriptor in the Service Description Table (SDT). The maximum length is 256 characters.
service_provider_name (Optional[str]) – The service provider name placed in the serviceDescriptor in the Service Description Table (SDT). The maximum length is 256 characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsdtsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

dvb_sdt_settings_property = medialive.CfnChannel.DvbSdtSettingsProperty(
    output_sdt="outputSdt",
    rep_interval=123,
    service_name="serviceName",
    service_provider_name="serviceProviderName"
)

Attributes

output_sdt

Selects a method of inserting SDT information into an output stream.

The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input. Otherwise, it falls back on the user-defined values. The sdtManual setting means that the user will enter the SDT information. The sdtNone setting means that the output stream will not contain SDT information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsdtsettings.html#cfn-medialive-channel-dvbsdtsettings-outputsdt

rep_interval

The number of milliseconds between instances of this table in the output transport stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsdtsettings.html#cfn-medialive-channel-dvbsdtsettings-repinterval

service_name

The service name placed in the serviceDescriptor in the Service Description Table (SDT).

The maximum length is 256 characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsdtsettings.html#cfn-medialive-channel-dvbsdtsettings-servicename

service_provider_name

The service provider name placed in the serviceDescriptor in the Service Description Table (SDT).

The maximum length is 256 characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsdtsettings.html#cfn-medialive-channel-dvbsdtsettings-serviceprovidername

DvbSubDestinationSettingsProperty

class CfnChannel.DvbSubDestinationSettingsProperty(*, alignment=None, background_color=None, background_opacity=None, font=None, font_color=None, font_opacity=None, font_resolution=None, font_size=None, outline_color=None, outline_size=None, shadow_color=None, shadow_opacity=None, shadow_x_offset=None, shadow_y_offset=None, teletext_grid_control=None, x_position=None, y_position=None)

Bases: object

The settings for DVB Sub captions in the output.

The parent of this entity is CaptionDestinationSettings.

Parameters:

alignment (Optional[str]) – If no explicit xPosition or yPosition is provided, setting the alignment to centered places the captions at the bottom center of the output. Similarly, setting a left alignment aligns captions to the bottom left of the output. If x and y positions are specified in conjunction with the alignment parameter, the font is justified (either left or centered) relative to those coordinates. Selecting “smart” justification left-justifies live subtitles and center-justifies pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.
background_color (Optional[str]) – Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
background_opacity (Union[int, float, None]) – Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
font (Union[IResolvable, InputLocationProperty, Dict[str, Any], None]) – The external font file that is used for captions burn-in. The file extension must be .ttf or .tte. Although you can select output fonts for many different types of input captions, embedded, STL, and Teletext sources use a strict grid system. Using external fonts with these captions sources could cause an unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
font_color (Optional[str]) – Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded, or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.
font_opacity (Union[int, float, None]) – Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
font_resolution (Union[int, float, None]) – The font resolution in DPI (dots per inch). The default is 96 dpi. All burn-in and DVB-Sub font settings must match.
font_size (Optional[str]) – When set to auto, fontSize scales depending on the size of the output. Providing a positive integer specifies the exact font size in points. All burn-in and DVB-Sub font settings must match.
outline_color (Optional[str]) – Specifies the font outline color. This option is not valid for source captions that are either 608/embedded or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.
outline_size (Union[int, float, None]) – Specifies the font outline size in pixels. This option is not valid for source captions that are either 608/embedded or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.
shadow_color (Optional[str]) – Specifies the color of the shadow that is cast by the captions. All burn-in and DVB-Sub font settings must match.
shadow_opacity (Union[int, float, None]) – Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
shadow_x_offset (Union[int, float, None]) – Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
shadow_y_offset (Union[int, float, None]) – Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
teletext_grid_control (Optional[str]) – Controls whether a fixed grid size is used to generate the output subtitles bitmap. This applies to only Teletext inputs and DVB-Sub/Burn-in outputs.
x_position (Union[int, float, None]) – Specifies the horizontal position of the captions relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal captions position is determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded, or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.
y_position (Union[int, float, None]) – Specifies the vertical position of the captions relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the captions are positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded, or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

dvb_sub_destination_settings_property = medialive.CfnChannel.DvbSubDestinationSettingsProperty(
    alignment="alignment",
    background_color="backgroundColor",
    background_opacity=123,
    font=medialive.CfnChannel.InputLocationProperty(
        password_param="passwordParam",
        uri="uri",
        username="username"
    ),
    font_color="fontColor",
    font_opacity=123,
    font_resolution=123,
    font_size="fontSize",
    outline_color="outlineColor",
    outline_size=123,
    shadow_color="shadowColor",
    shadow_opacity=123,
    shadow_xOffset=123,
    shadow_yOffset=123,
    teletext_grid_control="teletextGridControl",
    x_position=123,
    y_position=123
)

Attributes

alignment

If no explicit xPosition or yPosition is provided, setting the alignment to centered places the captions at the bottom center of the output.

Similarly, setting a left alignment aligns captions to the bottom left of the output. If x and y positions are specified in conjunction with the alignment parameter, the font is justified (either left or centered) relative to those coordinates. Selecting “smart” justification left-justifies live subtitles and center-justifies pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-alignment

background_color

Specifies the color of the rectangle behind the captions.

All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-backgroundcolor

background_opacity

Specifies the opacity of the background rectangle.

255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-backgroundopacity

font

The external font file that is used for captions burn-in.

The file extension must be .ttf or .tte. Although you can select output fonts for many different types of input captions, embedded, STL, and Teletext sources use a strict grid system. Using external fonts with these captions sources could cause an unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-font

font_color

Specifies the color of the burned-in captions.

This option is not valid for source captions that are STL, 608/embedded, or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-fontcolor

font_opacity

Specifies the opacity of the burned-in captions.

255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-fontopacity

font_resolution

The font resolution in DPI (dots per inch).

The default is 96 dpi. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-fontresolution

font_size

When set to auto, fontSize scales depending on the size of the output.

Providing a positive integer specifies the exact font size in points. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-fontsize

outline_color

Specifies the font outline color.

This option is not valid for source captions that are either 608/embedded or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-outlinecolor

outline_size

Specifies the font outline size in pixels.

This option is not valid for source captions that are either 608/embedded or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-outlinesize

shadow_color

Specifies the color of the shadow that is cast by the captions.

All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-shadowcolor

shadow_opacity

Specifies the opacity of the shadow.

255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-shadowopacity

shadow_x_offset

Specifies the horizontal offset of the shadow relative to the captions in pixels.

A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-shadowxoffset

shadow_y_offset

Specifies the vertical offset of the shadow relative to the captions in pixels.

A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-shadowyoffset

teletext_grid_control

Controls whether a fixed grid size is used to generate the output subtitles bitmap.

This applies to only Teletext inputs and DVB-Sub/Burn-in outputs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-teletextgridcontrol

x_position

Specifies the horizontal position of the captions relative to the left side of the output in pixels.

A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal captions position is determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded, or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-xposition

y_position

Specifies the vertical position of the captions relative to the top of the output in pixels.

A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the captions are positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded, or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbsubdestinationsettings.html#cfn-medialive-channel-dvbsubdestinationsettings-yposition

DvbSubSourceSettingsProperty

class CfnChannel.DvbSubSourceSettingsProperty(*, ocr_language=None, pid=None)

Bases: object

Information about the DVB Sub captions to extract from the input.

The parent of this entity is CaptionSelectorSettings.

Parameters:

ocr_language (Optional[str]) – 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.
pid (Union[int, float, None]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

dvb_sub_source_settings_property = medialive.CfnChannel.DvbSubSourceSettingsProperty(
    ocr_language="ocrLanguage",
    pid=123
)

Attributes

ocr_language

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

pid

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

DvbTdtSettingsProperty

class CfnChannel.DvbTdtSettingsProperty(*, rep_interval=None)

Bases: object

The DVB Time and Date Table (TDT).

The parent of this entity is M2tsSettings.

Parameters:: rep_interval (Union[int, float, None]) – The number of milliseconds between instances of this table in the output transport stream.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbtdtsettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

dvb_tdt_settings_property = medialive.CfnChannel.DvbTdtSettingsProperty(
    rep_interval=123
)

Attributes

rep_interval

The number of milliseconds between instances of this table in the output transport stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-dvbtdtsettings.html#cfn-medialive-channel-dvbtdtsettings-repinterval

Eac3AtmosSettingsProperty

class CfnChannel.Eac3AtmosSettingsProperty(*, bitrate=None, coding_mode=None, dialnorm=None, drc_line=None, drc_rf=None, height_trim=None, surround_trim=None)

Bases: object

Parameters:

bitrate (Union[int, float, None]) –
coding_mode (Optional[str]) –
dialnorm (Union[int, float, None]) –
drc_line (Optional[str]) –
drc_rf (Optional[str]) –
height_trim (Union[int, float, None]) –
surround_trim (Union[int, float, None]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3atmossettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

eac3_atmos_settings_property = medialive.CfnChannel.Eac3AtmosSettingsProperty(
    bitrate=123,
    coding_mode="codingMode",
    dialnorm=123,
    drc_line="drcLine",
    drc_rf="drcRf",
    height_trim=123,
    surround_trim=123
)

Attributes

bitrate

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3atmossettings.html#cfn-medialive-channel-eac3atmossettings-bitrate

Type:: see

coding_mode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3atmossettings.html#cfn-medialive-channel-eac3atmossettings-codingmode

Type:: see

dialnorm

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3atmossettings.html#cfn-medialive-channel-eac3atmossettings-dialnorm

Type:: see

drc_line

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3atmossettings.html#cfn-medialive-channel-eac3atmossettings-drcline

Type:: see

drc_rf

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3atmossettings.html#cfn-medialive-channel-eac3atmossettings-drcrf

Type:: see

height_trim

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3atmossettings.html#cfn-medialive-channel-eac3atmossettings-heighttrim

Type:: see

surround_trim

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3atmossettings.html#cfn-medialive-channel-eac3atmossettings-surroundtrim

Type:: see

Eac3SettingsProperty

class CfnChannel.Eac3SettingsProperty(*, attenuation_control=None, bitrate=None, bitstream_mode=None, coding_mode=None, dc_filter=None, dialnorm=None, drc_line=None, drc_rf=None, lfe_control=None, lfe_filter=None, lo_ro_center_mix_level=None, lo_ro_surround_mix_level=None, lt_rt_center_mix_level=None, lt_rt_surround_mix_level=None, metadata_control=None, passthrough_control=None, phase_control=None, stereo_downmix=None, surround_ex_mode=None, surround_mode=None)

Bases: object

The settings for an EAC3 audio encode in the output.

The parent of this entity is AudioCodecSettings.

Parameters:

attenuation_control (Optional[str]) – When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Used only for the 3/2 coding mode.
bitrate (Union[int, float, None]) – The average bitrate in bits/second. Valid bitrates depend on the coding mode.
bitstream_mode (Optional[str]) – Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. For more information, see ATSC A/52-2012 (Annex E).
coding_mode (Optional[str]) – The Dolby Digital Plus coding mode. This mode determines the number of channels.
dc_filter (Optional[str]) – When set to enabled, activates a DC highpass filter for all input channels.
dialnorm (Union[int, float, None]) – Sets the dialnorm for the output. If blank and the input audio is Dolby Digital Plus, dialnorm will be passed through.
drc_line (Optional[str]) – Sets the Dolby dynamic range compression profile.
drc_rf (Optional[str]) – Sets the profile for heavy Dolby dynamic range compression, ensuring that the instantaneous signal peaks do not exceed specified levels.
lfe_control (Optional[str]) – When encoding 3/2 audio, setting to lfe enables the LFE channel.
lfe_filter (Optional[str]) – When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Valid only with a codingMode32 coding mode.
lo_ro_center_mix_level (Union[int, float, None]) – The Left only/Right only center mix level. Used only for the 3/2 coding mode.
lo_ro_surround_mix_level (Union[int, float, None]) – The Left only/Right only surround mix level. Used only for a 3/2 coding mode.
lt_rt_center_mix_level (Union[int, float, None]) – The Left total/Right total center mix level. Used only for a 3/2 coding mode.
lt_rt_surround_mix_level (Union[int, float, None]) – The Left total/Right total surround mix level. Used only for the 3/2 coding mode.
metadata_control (Optional[str]) – When set to followInput, encoder metadata is sourced from the DD, DD+, or DolbyE decoder that supplies this audio data. If the audio is not supplied from one of these streams, then the static metadata settings are used.
passthrough_control (Optional[str]) – When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.
phase_control (Optional[str]) – When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Used only for a 3/2 coding mode.
stereo_downmix (Optional[str]) – A stereo downmix preference. Used only for the 3/2 coding mode.
surround_ex_mode (Optional[str]) – When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
surround_mode (Optional[str]) – When encoding 2/0 audio, sets whether Dolby Surround is matrix-encoded into the two channels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

eac3_settings_property = medialive.CfnChannel.Eac3SettingsProperty(
    attenuation_control="attenuationControl",
    bitrate=123,
    bitstream_mode="bitstreamMode",
    coding_mode="codingMode",
    dc_filter="dcFilter",
    dialnorm=123,
    drc_line="drcLine",
    drc_rf="drcRf",
    lfe_control="lfeControl",
    lfe_filter="lfeFilter",
    lo_ro_center_mix_level=123,
    lo_ro_surround_mix_level=123,
    lt_rt_center_mix_level=123,
    lt_rt_surround_mix_level=123,
    metadata_control="metadataControl",
    passthrough_control="passthroughControl",
    phase_control="phaseControl",
    stereo_downmix="stereoDownmix",
    surround_ex_mode="surroundExMode",
    surround_mode="surroundMode"
)

Attributes

attenuation_control

When set to attenuate3Db, applies a 3 dB attenuation to the surround channels.

Used only for the 3/2 coding mode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-attenuationcontrol

bitrate

The average bitrate in bits/second.

Valid bitrates depend on the coding mode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-bitrate

bitstream_mode

Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream.

For more information, see ATSC A/52-2012 (Annex E).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-bitstreammode

coding_mode

The Dolby Digital Plus coding mode.

This mode determines the number of channels.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-codingmode

dc_filter

When set to enabled, activates a DC highpass filter for all input channels.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-dcfilter

dialnorm

Sets the dialnorm for the output.

If blank and the input audio is Dolby Digital Plus, dialnorm will be passed through.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-dialnorm

drc_line

Sets the Dolby dynamic range compression profile.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-drcline

drc_rf

Sets the profile for heavy Dolby dynamic range compression, ensuring that the instantaneous signal peaks do not exceed specified levels.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-drcrf

lfe_control

When encoding 3/2 audio, setting to lfe enables the LFE channel.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-lfecontrol

lfe_filter

When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding.

Valid only with a codingMode32 coding mode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-lfefilter

lo_ro_center_mix_level

The Left only/Right only center mix level.

Used only for the 3/2 coding mode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-lorocentermixlevel

lo_ro_surround_mix_level

The Left only/Right only surround mix level.

Used only for a 3/2 coding mode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-lorosurroundmixlevel

lt_rt_center_mix_level

The Left total/Right total center mix level.

Used only for a 3/2 coding mode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-ltrtcentermixlevel

lt_rt_surround_mix_level

The Left total/Right total surround mix level.

Used only for the 3/2 coding mode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-ltrtsurroundmixlevel

metadata_control

When set to followInput, encoder metadata is sourced from the DD, DD+, or DolbyE decoder that supplies this audio data.

If the audio is not supplied from one of these streams, then the static metadata settings are used.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-metadatacontrol

passthrough_control

When set to whenPossible, input DD+ audio will be passed through if it is present on the input.

This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-passthroughcontrol

phase_control

When set to shift90Degrees, applies a 90-degree phase shift to the surround channels.

Used only for a 3/2 coding mode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-phasecontrol

stereo_downmix

A stereo downmix preference.

Used only for the 3/2 coding mode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-stereodownmix

surround_ex_mode

When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-surroundexmode

surround_mode

When encoding 2/0 audio, sets whether Dolby Surround is matrix-encoded into the two channels.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-eac3settings.html#cfn-medialive-channel-eac3settings-surroundmode

EbuTtDDestinationSettingsProperty

class CfnChannel.EbuTtDDestinationSettingsProperty(*, copyright_holder=None, fill_line_gap=None, font_family=None, style_control=None)

Bases: object

Settings for EBU-TT captions in the output.

The parent of this entity is CaptionDestinationSettings.

Parameters:

copyright_holder (Optional[str]) – Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. Complete this field if you want to include the name of the copyright holder in the copyright metadata tag in the TTML
fill_line_gap (Optional[str]) – Specifies how to handle the gap between the lines (in multi-line captions). - enabled: Fill with the captions background color (as specified in the input captions). - disabled: Leave the gap unfilled.
font_family (Optional[str]) – Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to “monospaced”. (If styleControl is set to exclude, the font family is always set to “monospaced”.) You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size. - Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font). - Leave blank to set the family to “monospace”.
style_control (Optional[str]) – Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. - exclude: In the font data attached to the EBU-TT captions, set the font family to “monospaced”. Do not include any other style information.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ebuttddestinationsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

ebu_tt_dDestination_settings_property = medialive.CfnChannel.EbuTtDDestinationSettingsProperty(
    copyright_holder="copyrightHolder",
    fill_line_gap="fillLineGap",
    font_family="fontFamily",
    style_control="styleControl"
)

Attributes

copyright_holder

Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output.

Complete this field if you want to include the name of the copyright holder in the copyright metadata tag in the TTML

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ebuttddestinationsettings.html#cfn-medialive-channel-ebuttddestinationsettings-copyrightholder

fill_line_gap

Specifies how to handle the gap between the lines (in multi-line captions).

enabled: Fill with the captions background color (as specified in the input captions).
disabled: Leave the gap unfilled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ebuttddestinationsettings.html#cfn-medialive-channel-ebuttddestinationsettings-filllinegap

font_family

Specifies the font family to include in the font data attached to the EBU-TT captions.

Valid only if styleControl is set to include. If you leave this field empty, the font family is set to “monospaced”. (If styleControl is set to exclude, the font family is always set to “monospaced”.) You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size. - Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font).

Leave blank to set the family to “monospace”.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ebuttddestinationsettings.html#cfn-medialive-channel-ebuttddestinationsettings-fontfamily

style_control

Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions.

include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext.
exclude: In the font data attached to the EBU-TT captions, set the font family to “monospaced”. Do not include any other style information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ebuttddestinationsettings.html#cfn-medialive-channel-ebuttddestinationsettings-stylecontrol

EmbeddedDestinationSettingsProperty

class CfnChannel.EmbeddedDestinationSettingsProperty

Bases: object

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-embeddeddestinationsettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

embedded_destination_settings_property = medialive.CfnChannel.EmbeddedDestinationSettingsProperty()

EmbeddedPlusScte20DestinationSettingsProperty

class CfnChannel.EmbeddedPlusScte20DestinationSettingsProperty

Bases: object

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-embeddedplusscte20destinationsettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

embedded_plus_scte20_destination_settings_property = medialive.CfnChannel.EmbeddedPlusScte20DestinationSettingsProperty()

EmbeddedSourceSettingsProperty

class CfnChannel.EmbeddedSourceSettingsProperty(*, convert608_to708=None, scte20_detection=None, source608_channel_number=None, source608_track_number=None)

Bases: object

Information about the embedded captions to extract from the input.

The parent of this entity is CaptionSelectorSettings.

Parameters:

convert608_to708 (Optional[str]) – 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.
scte20_detection (Optional[str]) – Set to “auto” to handle streams with intermittent or non-aligned SCTE-20 and embedded captions.
source608_channel_number (Union[int, float, None]) – Specifies the 608/708 channel number within the video track from which to extract captions. This is unused for passthrough.
source608_track_number (Union[int, float, None]) – This field is unused and deprecated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-embeddedsourcesettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

embedded_source_settings_property = medialive.CfnChannel.EmbeddedSourceSettingsProperty(
    convert608_to708="convert608To708",
    scte20_detection="scte20Detection",
    source608_channel_number=123,
    source608_track_number=123
)

Attributes

convert608_to708

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

scte20_detection

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

source608_channel_number

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

source608_track_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

EncoderSettingsProperty

class CfnChannel.EncoderSettingsProperty(*, audio_descriptions=None, avail_blanking=None, avail_configuration=None, blackout_slate=None, caption_descriptions=None, color_correction_settings=None, feature_activations=None, global_configuration=None, motion_graphics_configuration=None, nielsen_configuration=None, output_groups=None, thumbnail_configuration=None, timecode_config=None, video_descriptions=None)

Bases: object

The settings for the encoding of outputs.

This entity is at the top level in the channel.

Parameters:

audio_descriptions (Union[IResolvable, Sequence[Union[IResolvable, AudioDescriptionProperty, Dict[str, Any]]], None]) – The encoding information for output audio.
avail_blanking (Union[IResolvable, AvailBlankingProperty, Dict[str, Any], None]) – The settings for ad avail blanking.
avail_configuration (Union[IResolvable, AvailConfigurationProperty, Dict[str, Any], None]) – The configuration settings for the ad avail handling.
blackout_slate (Union[IResolvable, BlackoutSlateProperty, Dict[str, Any], None]) – The settings for the blackout slate.
caption_descriptions (Union[IResolvable, Sequence[Union[IResolvable, CaptionDescriptionProperty, Dict[str, Any]]], None]) – The encoding information for output captions.
color_correction_settings (Union[IResolvable, ColorCorrectionSettingsProperty, Dict[str, Any], None]) –
feature_activations (Union[IResolvable, FeatureActivationsProperty, Dict[str, Any], None]) – Settings to enable specific features.
global_configuration (Union[IResolvable, GlobalConfigurationProperty, Dict[str, Any], None]) – The configuration settings that apply to the entire channel.
motion_graphics_configuration (Union[IResolvable, MotionGraphicsConfigurationProperty, Dict[str, Any], None]) – Settings to enable and configure the motion graphics overlay feature in the channel.
nielsen_configuration (Union[IResolvable, NielsenConfigurationProperty, Dict[str, Any], None]) – The settings to configure Nielsen watermarks.
output_groups (Union[IResolvable, Sequence[Union[IResolvable, OutputGroupProperty, Dict[str, Any]]], None]) – The settings for the output groups in the channel.
thumbnail_configuration (Union[IResolvable, ThumbnailConfigurationProperty, Dict[str, Any], None]) –
timecode_config (Union[IResolvable, TimecodeConfigProperty, Dict[str, Any], None]) – Contains settings used to acquire and adjust timecode information from the inputs.
video_descriptions (Union[IResolvable, Sequence[Union[IResolvable, VideoDescriptionProperty, Dict[str, Any]]], None]) – The encoding information for output videos.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-encodersettings.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes

audio_descriptions

The encoding information for output audio.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-encodersettings.html#cfn-medialive-channel-encodersettings-audiodescriptions

avail_blanking

The settings for ad avail blanking.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-encodersettings.html#cfn-medialive-channel-encodersettings-availblanking

avail_configuration

The configuration settings for the ad avail handling.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-encodersettings.html#cfn-medialive-channel-encodersettings-availconfiguration

blackout_slate

The settings for the blackout slate.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-encodersettings.html#cfn-medialive-channel-encodersettings-blackoutslate

caption_descriptions

The encoding information for output captions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-encodersettings.html#cfn-medialive-channel-encodersettings-captiondescriptions

color_correction_settings

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-encodersettings.html#cfn-medialive-channel-encodersettings-colorcorrectionsettings

Type:: see

feature_activations

Settings to enable specific features.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-encodersettings.html#cfn-medialive-channel-encodersettings-featureactivations

global_configuration

The configuration settings that apply to the entire channel.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-encodersettings.html#cfn-medialive-channel-encodersettings-globalconfiguration

motion_graphics_configuration

Settings to enable and configure the motion graphics overlay feature in the channel.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-encodersettings.html#cfn-medialive-channel-encodersettings-motiongraphicsconfiguration

nielsen_configuration

The settings to configure Nielsen watermarks.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-encodersettings.html#cfn-medialive-channel-encodersettings-nielsenconfiguration

output_groups

The settings for the output groups in the channel.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-encodersettings.html#cfn-medialive-channel-encodersettings-outputgroups

thumbnail_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-encodersettings.html#cfn-medialive-channel-encodersettings-thumbnailconfiguration

Type:: see

timecode_config

Contains settings used to acquire and adjust timecode information from the inputs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-encodersettings.html#cfn-medialive-channel-encodersettings-timecodeconfig

video_descriptions

The encoding information for output videos.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-encodersettings.html#cfn-medialive-channel-encodersettings-videodescriptions

EpochLockingSettingsProperty

class CfnChannel.EpochLockingSettingsProperty(*, custom_epoch=None, jam_sync_time=None)

Bases: object

Parameters:

custom_epoch (Optional[str]) –
jam_sync_time (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-epochlockingsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

epoch_locking_settings_property = medialive.CfnChannel.EpochLockingSettingsProperty(
    custom_epoch="customEpoch",
    jam_sync_time="jamSyncTime"
)

Attributes

custom_epoch

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-epochlockingsettings.html#cfn-medialive-channel-epochlockingsettings-customepoch

Type:: see

jam_sync_time

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-epochlockingsettings.html#cfn-medialive-channel-epochlockingsettings-jamsynctime

Type:: see

EsamProperty

class CfnChannel.EsamProperty(*, acquisition_point_id=None, ad_avail_offset=None, password_param=None, pois_endpoint=None, username=None, zone_identity=None)

Bases: object

Parameters:

acquisition_point_id (Optional[str]) –
ad_avail_offset (Union[int, float, None]) –
password_param (Optional[str]) –
pois_endpoint (Optional[str]) –
username (Optional[str]) –
zone_identity (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-esam.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

esam_property = medialive.CfnChannel.EsamProperty(
    acquisition_point_id="acquisitionPointId",
    ad_avail_offset=123,
    password_param="passwordParam",
    pois_endpoint="poisEndpoint",
    username="username",
    zone_identity="zoneIdentity"
)

Attributes

acquisition_point_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-esam.html#cfn-medialive-channel-esam-acquisitionpointid

Type:: see

ad_avail_offset

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-esam.html#cfn-medialive-channel-esam-adavailoffset

Type:: see

password_param

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-esam.html#cfn-medialive-channel-esam-passwordparam

Type:: see

pois_endpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-esam.html#cfn-medialive-channel-esam-poisendpoint

Type:: see

username

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-esam.html#cfn-medialive-channel-esam-username

Type:: see

zone_identity

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-esam.html#cfn-medialive-channel-esam-zoneidentity

Type:: see

FailoverConditionProperty

class CfnChannel.FailoverConditionProperty(*, failover_condition_settings=None)

Bases: object

Failover Condition settings. There can be multiple failover conditions inside AutomaticInputFailoverSettings.

The parent of this entity is AutomaticInputFailoverSettings.

Parameters:: failover_condition_settings (Union[IResolvable, FailoverConditionSettingsProperty, Dict[str, Any], None]) – Settings for a specific failover condition.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-failovercondition.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

failover_condition_property = medialive.CfnChannel.FailoverConditionProperty(
    failover_condition_settings=medialive.CfnChannel.FailoverConditionSettingsProperty(
        audio_silence_settings=medialive.CfnChannel.AudioSilenceFailoverSettingsProperty(
            audio_selector_name="audioSelectorName",
            audio_silence_threshold_msec=123
        ),
        input_loss_settings=medialive.CfnChannel.InputLossFailoverSettingsProperty(
            input_loss_threshold_msec=123
        ),
        video_black_settings=medialive.CfnChannel.VideoBlackFailoverSettingsProperty(
            black_detect_threshold=123,
            video_black_threshold_msec=123
        )
    )
)

Attributes

failover_condition_settings

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

FailoverConditionSettingsProperty

class CfnChannel.FailoverConditionSettingsProperty(*, audio_silence_settings=None, input_loss_settings=None, video_black_settings=None)

Bases: object

Settings for one failover condition.

The parent of this entity is FailoverCondition.

Parameters:

audio_silence_settings (Union[IResolvable, AudioSilenceFailoverSettingsProperty, Dict[str, Any], None]) – MediaLive will perform a failover if the specified audio selector is silent for the specified period.
input_loss_settings (Union[IResolvable, InputLossFailoverSettingsProperty, Dict[str, Any], None]) – MediaLive will perform a failover if content is not detected in this input for the specified period.
video_black_settings (Union[IResolvable, VideoBlackFailoverSettingsProperty, Dict[str, Any], None]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

failover_condition_settings_property = medialive.CfnChannel.FailoverConditionSettingsProperty(
    audio_silence_settings=medialive.CfnChannel.AudioSilenceFailoverSettingsProperty(
        audio_selector_name="audioSelectorName",
        audio_silence_threshold_msec=123
    ),
    input_loss_settings=medialive.CfnChannel.InputLossFailoverSettingsProperty(
        input_loss_threshold_msec=123
    ),
    video_black_settings=medialive.CfnChannel.VideoBlackFailoverSettingsProperty(
        black_detect_threshold=123,
        video_black_threshold_msec=123
    )
)

Attributes

audio_silence_settings

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

input_loss_settings

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

video_black_settings

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

FeatureActivationsProperty

class CfnChannel.FeatureActivationsProperty(*, input_prepare_schedule_actions=None, output_static_image_overlay_schedule_actions=None)

Bases: object

Settings to enable specific features. You can’t configure these features until you have enabled them in the channel.

The parent of this entity is EncoderSettings.

Parameters:

input_prepare_schedule_actions (Optional[str]) – Enables the Input Prepare feature. You can create Input Prepare actions in the schedule only if this feature is enabled. If you disable the feature on an existing schedule, make sure that you first delete all input prepare actions from the schedule.
output_static_image_overlay_schedule_actions (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-featureactivations.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

feature_activations_property = medialive.CfnChannel.FeatureActivationsProperty(
    input_prepare_schedule_actions="inputPrepareScheduleActions",
    output_static_image_overlay_schedule_actions="outputStaticImageOverlayScheduleActions"
)

Attributes

input_prepare_schedule_actions

Enables the Input Prepare feature.

You can create Input Prepare actions in the schedule only if this feature is enabled. If you disable the feature on an existing schedule, make sure that you first delete all input prepare actions from the schedule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-featureactivations.html#cfn-medialive-channel-featureactivations-inputpreparescheduleactions

output_static_image_overlay_schedule_actions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-featureactivations.html#cfn-medialive-channel-featureactivations-outputstaticimageoverlayscheduleactions

Type:: see

FecOutputSettingsProperty

class CfnChannel.FecOutputSettingsProperty(*, column_depth=None, include_fec=None, row_length=None)

Bases: object

The settings for FEC.

The parent of this entity is UdpOutputSettings.

Parameters:

column_depth (Union[int, float, None]) – The parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. The number must be between 4 and 20, inclusive.
include_fec (Optional[str]) – Enables column only or column and row-based FEC.
row_length (Union[int, float, None]) – The parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-fecoutputsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

fec_output_settings_property = medialive.CfnChannel.FecOutputSettingsProperty(
    column_depth=123,
    include_fec="includeFec",
    row_length=123
)

Attributes

column_depth

The parameter D from SMPTE 2022-1.

The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. The number must be between 4 and 20, inclusive.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-fecoutputsettings.html#cfn-medialive-channel-fecoutputsettings-columndepth

include_fec

Enables column only or column and row-based FEC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-fecoutputsettings.html#cfn-medialive-channel-fecoutputsettings-includefec

row_length

The parameter L from SMPTE 2022-1.

The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-fecoutputsettings.html#cfn-medialive-channel-fecoutputsettings-rowlength

Fmp4HlsSettingsProperty

class CfnChannel.Fmp4HlsSettingsProperty(*, audio_rendition_sets=None, nielsen_id3_behavior=None, timed_metadata_behavior=None)

Bases: object

Settings for the fMP4 containers.

The parent of this entity is HlsSettings.

Parameters:

audio_rendition_sets (Optional[str]) – List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ‘,’.
nielsen_id3_behavior (Optional[str]) – If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
timed_metadata_behavior (Optional[str]) – When set to passthrough, timed metadata is passed through from input to output.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-fmp4hlssettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

fmp4_hls_settings_property = medialive.CfnChannel.Fmp4HlsSettingsProperty(
    audio_rendition_sets="audioRenditionSets",
    nielsen_id3_behavior="nielsenId3Behavior",
    timed_metadata_behavior="timedMetadataBehavior"
)

Attributes

audio_rendition_sets

List all the audio groups that are used with the video output stream.

Input all the audio GROUP-IDs that are associated to the video, separate by ‘,’.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-fmp4hlssettings.html#cfn-medialive-channel-fmp4hlssettings-audiorenditionsets

nielsen_id3_behavior

If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-fmp4hlssettings.html#cfn-medialive-channel-fmp4hlssettings-nielsenid3behavior

timed_metadata_behavior

When set to passthrough, timed metadata is passed through from input to output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-fmp4hlssettings.html#cfn-medialive-channel-fmp4hlssettings-timedmetadatabehavior

FrameCaptureCdnSettingsProperty

class CfnChannel.FrameCaptureCdnSettingsProperty(*, frame_capture_s3_settings=None)

Bases: object

Settings to configure the destination of a Frame Capture output.

The parent of this entity is FrameCaptureGroupSettings.

Parameters:: frame_capture_s3_settings (Union[IResolvable, FrameCaptureS3SettingsProperty, Dict[str, Any], None]) – Sets up Amazon S3 as the destination for this Frame Capture output.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-framecapturecdnsettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

frame_capture_cdn_settings_property = medialive.CfnChannel.FrameCaptureCdnSettingsProperty(
    frame_capture_s3_settings=medialive.CfnChannel.FrameCaptureS3SettingsProperty(
        canned_acl="cannedAcl"
    )
)

Attributes

frame_capture_s3_settings

Sets up Amazon S3 as the destination for this Frame Capture output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-framecapturecdnsettings.html#cfn-medialive-channel-framecapturecdnsettings-framecaptures3settings

FrameCaptureGroupSettingsProperty

class CfnChannel.FrameCaptureGroupSettingsProperty(*, destination=None, frame_capture_cdn_settings=None)

Bases: object

The settings for a frame capture output group.

The parent of this entity is OutputGroupSettings.

Parameters:

destination (Union[IResolvable, OutputLocationRefProperty, Dict[str, Any], None]) – The destination for the frame capture files. The destination is either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, “curling_”) + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg.
frame_capture_cdn_settings (Union[IResolvable, FrameCaptureCdnSettingsProperty, Dict[str, Any], None]) – Settings to configure the destination of a Frame Capture output.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-framecapturegroupsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

frame_capture_group_settings_property = medialive.CfnChannel.FrameCaptureGroupSettingsProperty(
    destination=medialive.CfnChannel.OutputLocationRefProperty(
        destination_ref_id="destinationRefId"
    ),
    frame_capture_cdn_settings=medialive.CfnChannel.FrameCaptureCdnSettingsProperty(
        frame_capture_s3_settings=medialive.CfnChannel.FrameCaptureS3SettingsProperty(
            canned_acl="cannedAcl"
        )
    )
)

Attributes

destination

The destination for the frame capture files.

The destination is either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, “curling_”) + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-framecapturegroupsettings.html#cfn-medialive-channel-framecapturegroupsettings-destination

frame_capture_cdn_settings

Settings to configure the destination of a Frame Capture output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-framecapturegroupsettings.html#cfn-medialive-channel-framecapturegroupsettings-framecapturecdnsettings

FrameCaptureHlsSettingsProperty

class CfnChannel.FrameCaptureHlsSettingsProperty

Bases: object

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-framecapturehlssettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

frame_capture_hls_settings_property = medialive.CfnChannel.FrameCaptureHlsSettingsProperty()

FrameCaptureOutputSettingsProperty

class CfnChannel.FrameCaptureOutputSettingsProperty(*, name_modifier=None)

Bases: object

The frame capture output settings.

The parent of this entity is OutputSettings.

Parameters:: name_modifier (Optional[str]) – Required if the output group contains more than one output. This modifier forms part of the output file name.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-framecaptureoutputsettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

frame_capture_output_settings_property = medialive.CfnChannel.FrameCaptureOutputSettingsProperty(
    name_modifier="nameModifier"
)

Attributes

name_modifier

Required if the output group contains more than one output.

This modifier forms part of the output file name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-framecaptureoutputsettings.html#cfn-medialive-channel-framecaptureoutputsettings-namemodifier

FrameCaptureS3SettingsProperty

class CfnChannel.FrameCaptureS3SettingsProperty(*, canned_acl=None)

Bases: object

Sets up Amazon S3 as the destination for this Frame Capture output.

The parent of this entity is FrameCaptureCdnSettings.

Parameters:: canned_acl (Optional[str]) – Specify the canned ACL to apply to each S3 request. Defaults to none.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-framecaptures3settings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

frame_capture_s3_settings_property = medialive.CfnChannel.FrameCaptureS3SettingsProperty(
    canned_acl="cannedAcl"
)

Attributes

canned_acl

Specify the canned ACL to apply to each S3 request.

Defaults to none.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-framecaptures3settings.html#cfn-medialive-channel-framecaptures3settings-cannedacl

FrameCaptureSettingsProperty

class CfnChannel.FrameCaptureSettingsProperty(*, capture_interval=None, capture_interval_units=None, timecode_burnin_settings=None)

Bases: object

The frame capture settings.

The parent of this entity is VideoCodecSettings.

Parameters:

capture_interval (Union[int, float, None]) – The frequency, in seconds, for capturing frames for inclusion in the output. For example, “10” means capture a frame every 10 seconds.
capture_interval_units (Optional[str]) – Unit for the frame capture interval.
timecode_burnin_settings (Union[IResolvable, TimecodeBurninSettingsProperty, Dict[str, Any], None]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-framecapturesettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

frame_capture_settings_property = medialive.CfnChannel.FrameCaptureSettingsProperty(
    capture_interval=123,
    capture_interval_units="captureIntervalUnits",
    timecode_burnin_settings=medialive.CfnChannel.TimecodeBurninSettingsProperty(
        font_size="fontSize",
        position="position",
        prefix="prefix"
    )
)

Attributes

capture_interval

The frequency, in seconds, for capturing frames for inclusion in the output.

For example, “10” means capture a frame every 10 seconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-framecapturesettings.html#cfn-medialive-channel-framecapturesettings-captureinterval

capture_interval_units

Unit for the frame capture interval.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-framecapturesettings.html#cfn-medialive-channel-framecapturesettings-captureintervalunits

timecode_burnin_settings

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-framecapturesettings.html#cfn-medialive-channel-framecapturesettings-timecodeburninsettings

Type:: see

GlobalConfigurationProperty

class CfnChannel.GlobalConfigurationProperty(*, initial_audio_gain=None, input_end_action=None, input_loss_behavior=None, output_locking_mode=None, output_locking_settings=None, output_timing_source=None, support_low_framerate_inputs=None)

Bases: object

The configuration settings that apply to the entire channel.

The parent of this entity is EncoderSettings.

Parameters:

initial_audio_gain (Union[int, float, None]) – The value to set the initial audio gain for the channel.
input_end_action (Optional[str]) – Indicates the action to take when the current input completes (for example, end-of-file). When switchAndLoopInputs is configured, MediaLive restarts at the beginning of the first input. When “none” is configured, MediaLive transcodes either black, a solid color, or a user-specified slate images per the “Input Loss Behavior” configuration until the next input switch occurs (which is controlled through the Channel Schedule API).
input_loss_behavior (Union[IResolvable, InputLossBehaviorProperty, Dict[str, Any], None]) – The settings for system actions when the input is lost.
output_locking_mode (Optional[str]) – Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive attempts to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive attempts to synchronize the output of each pipeline to the Unix epoch.
output_locking_settings (Union[IResolvable, OutputLockingSettingsProperty, Dict[str, Any], None]) –
output_timing_source (Optional[str]) – Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally might be locked to another source through NTP) or should be locked to the clock of the source that is providing the input stream.
support_low_framerate_inputs (Optional[str]) – Adjusts the video input buffer for streams with very low video frame rates. This is commonly set to enabled for music channels with less than one video frame per second.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-globalconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

# pipeline_locking_settings: Any

global_configuration_property = medialive.CfnChannel.GlobalConfigurationProperty(
    initial_audio_gain=123,
    input_end_action="inputEndAction",
    input_loss_behavior=medialive.CfnChannel.InputLossBehaviorProperty(
        black_frame_msec=123,
        input_loss_image_color="inputLossImageColor",
        input_loss_image_slate=medialive.CfnChannel.InputLocationProperty(
            password_param="passwordParam",
            uri="uri",
            username="username"
        ),
        input_loss_image_type="inputLossImageType",
        repeat_frame_msec=123
    ),
    output_locking_mode="outputLockingMode",
    output_locking_settings=medialive.CfnChannel.OutputLockingSettingsProperty(
        epoch_locking_settings=medialive.CfnChannel.EpochLockingSettingsProperty(
            custom_epoch="customEpoch",
            jam_sync_time="jamSyncTime"
        ),
        pipeline_locking_settings=pipeline_locking_settings
    ),
    output_timing_source="outputTimingSource",
    support_low_framerate_inputs="supportLowFramerateInputs"
)

Attributes

initial_audio_gain

The value to set the initial audio gain for the channel.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-globalconfiguration.html#cfn-medialive-channel-globalconfiguration-initialaudiogain

input_end_action

Indicates the action to take when the current input completes (for example, end-of-file).

When switchAndLoopInputs is configured, MediaLive restarts at the beginning of the first input. When “none” is configured, MediaLive transcodes either black, a solid color, or a user-specified slate images per the “Input Loss Behavior” configuration until the next input switch occurs (which is controlled through the Channel Schedule API).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-globalconfiguration.html#cfn-medialive-channel-globalconfiguration-inputendaction

input_loss_behavior

The settings for system actions when the input is lost.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-globalconfiguration.html#cfn-medialive-channel-globalconfiguration-inputlossbehavior

output_locking_mode

Indicates how MediaLive pipelines are synchronized.

PIPELINELOCKING - MediaLive attempts to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive attempts to synchronize the output of each pipeline to the Unix epoch.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-globalconfiguration.html#cfn-medialive-channel-globalconfiguration-outputlockingmode

output_locking_settings

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-globalconfiguration.html#cfn-medialive-channel-globalconfiguration-outputlockingsettings

Type:: see

output_timing_source

Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally might be locked to another source through NTP) or should be locked to the clock of the source that is providing the input stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-globalconfiguration.html#cfn-medialive-channel-globalconfiguration-outputtimingsource

support_low_framerate_inputs

Adjusts the video input buffer for streams with very low video frame rates.

This is commonly set to enabled for music channels with less than one video frame per second.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-globalconfiguration.html#cfn-medialive-channel-globalconfiguration-supportlowframerateinputs

H264ColorSpaceSettingsProperty

class CfnChannel.H264ColorSpaceSettingsProperty(*, color_space_passthrough_settings=None, rec601_settings=None, rec709_settings=None)

Bases: object

Settings for configuring color space in an H264 video encode.

The parent of this entity is H264Settings.

Parameters:

color_space_passthrough_settings (Union[IResolvable, ColorSpacePassthroughSettingsProperty, Dict[str, Any], None]) – Passthrough applies no color space conversion to the output.
rec601_settings (Union[IResolvable, Rec601SettingsProperty, Dict[str, Any], None]) – Settings to configure the handling of Rec601 color space.
rec709_settings (Union[IResolvable, Rec709SettingsProperty, Dict[str, Any], None]) – Settings to configure the handling of Rec709 color space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264colorspacesettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

h264_color_space_settings_property = medialive.CfnChannel.H264ColorSpaceSettingsProperty(
    color_space_passthrough_settings=medialive.CfnChannel.ColorSpacePassthroughSettingsProperty(),
    rec601_settings=medialive.CfnChannel.Rec601SettingsProperty(),
    rec709_settings=medialive.CfnChannel.Rec709SettingsProperty()
)

Attributes

color_space_passthrough_settings

Passthrough applies no color space conversion to the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264colorspacesettings.html#cfn-medialive-channel-h264colorspacesettings-colorspacepassthroughsettings

rec601_settings

Settings to configure the handling of Rec601 color space.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264colorspacesettings.html#cfn-medialive-channel-h264colorspacesettings-rec601settings

rec709_settings

Settings to configure the handling of Rec709 color space.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264colorspacesettings.html#cfn-medialive-channel-h264colorspacesettings-rec709settings

H264FilterSettingsProperty

class CfnChannel.H264FilterSettingsProperty(*, temporal_filter_settings=None)

Bases: object

Settings to configure video filters that apply to the H264 codec.

The parent of this entity is H264Settings.

Parameters:: temporal_filter_settings (Union[IResolvable, TemporalFilterSettingsProperty, Dict[str, Any], None]) – Settings for applying the temporal filter to the video.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264filtersettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

h264_filter_settings_property = medialive.CfnChannel.H264FilterSettingsProperty(
    temporal_filter_settings=medialive.CfnChannel.TemporalFilterSettingsProperty(
        post_filter_sharpening="postFilterSharpening",
        strength="strength"
    )
)

Attributes

temporal_filter_settings

Settings for applying the temporal filter to the video.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264filtersettings.html#cfn-medialive-channel-h264filtersettings-temporalfiltersettings

H264SettingsProperty

class CfnChannel.H264SettingsProperty(*, adaptive_quantization=None, afd_signaling=None, bitrate=None, buf_fill_pct=None, buf_size=None, color_metadata=None, color_space_settings=None, entropy_encoding=None, filter_settings=None, fixed_afd=None, flicker_aq=None, force_field_pictures=None, framerate_control=None, framerate_denominator=None, framerate_numerator=None, gop_b_reference=None, gop_closed_cadence=None, gop_num_b_frames=None, gop_size=None, gop_size_units=None, level=None, look_ahead_rate_control=None, max_bitrate=None, min_i_interval=None, num_ref_frames=None, par_control=None, par_denominator=None, par_numerator=None, profile=None, quality_level=None, qvbr_quality_level=None, rate_control_mode=None, scan_type=None, scene_change_detect=None, slices=None, softness=None, spatial_aq=None, subgop_length=None, syntax=None, temporal_aq=None, timecode_burnin_settings=None, timecode_insertion=None)

Bases: object

The settings for the H.264 codec in the output.

The parent of this entity is VideoCodecSettings.

Parameters:

adaptive_quantization (Optional[str]) – The adaptive quantization. This allows intra-frame quantizers to vary to improve visual quality.
afd_signaling (Optional[str]) – Indicates that AFD values will be written into the output stream. If afdSignaling is auto, the system tries to preserve the input AFD value (in cases where multiple AFD values are valid). If set to fixed, the AFD value is the value configured in the fixedAfd parameter.
bitrate (Union[int, float, None]) – The average bitrate in bits/second. This is required when the rate control mode is VBR or CBR. It isn’t used for QVBR. In a Microsoft Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
buf_fill_pct (Union[int, float, None]) – The percentage of the buffer that should initially be filled (HRD buffer model).
buf_size (Union[int, float, None]) – The size of the buffer (HRD buffer model) in bits/second.
color_metadata (Optional[str]) – Includes color space metadata in the output.
color_space_settings (Union[IResolvable, H264ColorSpaceSettingsProperty, Dict[str, Any], None]) – Settings to configure the color space handling for the video.
entropy_encoding (Optional[str]) – The entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.
filter_settings (Union[IResolvable, H264FilterSettingsProperty, Dict[str, Any], None]) – Optional filters that you can apply to an encode.
fixed_afd (Optional[str]) – A four-bit AFD value to write on all frames of video in the output stream. Valid only when afdSignaling is set to Fixed.
flicker_aq (Optional[str]) – If set to enabled, adjusts the quantization within each frame to reduce flicker or pop on I-frames.
force_field_pictures (Optional[str]) – This setting applies only when scan type is “interlaced.” It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.) enabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately. disabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content.
framerate_control (Optional[str]) – Indicates how the output video frame rate is specified. If you select “specified,” the output video frame rate is determined by framerateNumerator and framerateDenominator. If you select “initializeFromSource,” the output video frame rate is set equal to the input video frame rate of the first input.
framerate_denominator (Union[int, float, None]) – The frame rate denominator.
framerate_numerator (Union[int, float, None]) – The frame rate numerator. The frame rate is a fraction, for example, 24000/1001 = 23.976 fps.
gop_b_reference (Optional[str]) – If enabled, uses reference B frames for GOP structures that have B frames > 1.
gop_closed_cadence (Union[int, float, None]) – The frequency of closed GOPs. In streaming applications, we recommend that you set this to 1 so that a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
gop_num_b_frames (Union[int, float, None]) – The number of B-frames between reference frames.
gop_size (Union[int, float, None]) – The GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. The value must be greater than zero.
gop_size_units (Optional[str]) – Indicates if the gopSize is specified in frames or seconds. If seconds, the system converts the gopSize into a frame count at runtime.
level (Optional[str]) – The H.264 level.
look_ahead_rate_control (Optional[str]) – The amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
max_bitrate (Union[int, float, None]) – For QVBR: See the tooltip for Quality level. For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
min_i_interval (Union[int, float, None]) – Meaningful only if sceneChangeDetect is set to enabled. This setting enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting the I-interval. The normal cadence resumes for the next GOP. Note that the maximum GOP stretch = GOP size + Min-I-interval - 1.
num_ref_frames (Union[int, float, None]) – The number of reference frames to use. The encoder might use more than requested if you use B-frames or interlaced encoding.
par_control (Optional[str]) – Indicates how the output pixel aspect ratio is specified. If “specified” is selected, the output video pixel aspect ratio is determined by parNumerator and parDenominator. If “initializeFromSource” is selected, the output pixels aspect ratio will be set equal to the input video pixel aspect ratio of the first input.
par_denominator (Union[int, float, None]) – The Pixel Aspect Ratio denominator.
par_numerator (Union[int, float, None]) – The Pixel Aspect Ratio numerator.
profile (Optional[str]) – An H.264 profile.
quality_level (Optional[str]) – Leave as STANDARD_QUALITY or choose a different value (which might result in additional costs to run the channel). - ENHANCED_QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED_QUALITY. - STANDARD_QUALITY: Valid for any Rate control mode.
qvbr_quality_level (Union[int, float, None]) – Controls the target quality for the video encode. This applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M.
rate_control_mode (Optional[str]) – The rate control mode. QVBR: The quality will match the specified quality level except when it is constrained by the maximum bitrate. We recommend this if you or your viewers pay for bandwidth. VBR: The quality and bitrate vary, depending on the video complexity. We recommend this instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: The quality varies, depending on the video complexity. We recommend this only if you distribute your assets to devices that can’t handle variable bitrates.
scan_type (Optional[str]) – Sets the scan type of the output to progressive or top-field-first interlaced.
scene_change_detect (Optional[str]) – The scene change detection. On: inserts I-frames when the scene change is detected. Off: does not force an I-frame when the scene change is detected.
slices (Union[int, float, None]) – The number of slices per picture. The number must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional. If you don’t specify a value, MediaLive chooses the number of slices based on the encode resolution.
softness (Union[int, float, None]) – Softness. Selects a quantizer matrix. Larger values reduce high-frequency content in the encoded image.
spatial_aq (Optional[str]) – If set to enabled, adjusts quantization within each frame based on the spatial variation of content complexity.
subgop_length (Optional[str]) – If set to fixed, uses gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimizes the number of B-frames used for each sub-GOP to improve visual quality.
syntax (Optional[str]) – Produces a bitstream that is compliant with SMPTE RP-2027.
temporal_aq (Optional[str]) – If set to enabled, adjusts quantization within each frame based on the temporal variation of content complexity.
timecode_burnin_settings (Union[IResolvable, TimecodeBurninSettingsProperty, Dict[str, Any], None]) –
timecode_insertion (Optional[str]) – Determines how timecodes should be inserted into the video elementary stream. disabled: don’t include timecodes. picTimingSei: pass through picture timing SEI messages from the source specified in Timecode Config.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

h264_settings_property = medialive.CfnChannel.H264SettingsProperty(
    adaptive_quantization="adaptiveQuantization",
    afd_signaling="afdSignaling",
    bitrate=123,
    buf_fill_pct=123,
    buf_size=123,
    color_metadata="colorMetadata",
    color_space_settings=medialive.CfnChannel.H264ColorSpaceSettingsProperty(
        color_space_passthrough_settings=medialive.CfnChannel.ColorSpacePassthroughSettingsProperty(),
        rec601_settings=medialive.CfnChannel.Rec601SettingsProperty(),
        rec709_settings=medialive.CfnChannel.Rec709SettingsProperty()
    ),
    entropy_encoding="entropyEncoding",
    filter_settings=medialive.CfnChannel.H264FilterSettingsProperty(
        temporal_filter_settings=medialive.CfnChannel.TemporalFilterSettingsProperty(
            post_filter_sharpening="postFilterSharpening",
            strength="strength"
        )
    ),
    fixed_afd="fixedAfd",
    flicker_aq="flickerAq",
    force_field_pictures="forceFieldPictures",
    framerate_control="framerateControl",
    framerate_denominator=123,
    framerate_numerator=123,
    gop_bReference="gopBReference",
    gop_closed_cadence=123,
    gop_num_bFrames=123,
    gop_size=123,
    gop_size_units="gopSizeUnits",
    level="level",
    look_ahead_rate_control="lookAheadRateControl",
    max_bitrate=123,
    min_iInterval=123,
    num_ref_frames=123,
    par_control="parControl",
    par_denominator=123,
    par_numerator=123,
    profile="profile",
    quality_level="qualityLevel",
    qvbr_quality_level=123,
    rate_control_mode="rateControlMode",
    scan_type="scanType",
    scene_change_detect="sceneChangeDetect",
    slices=123,
    softness=123,
    spatial_aq="spatialAq",
    subgop_length="subgopLength",
    syntax="syntax",
    temporal_aq="temporalAq",
    timecode_burnin_settings=medialive.CfnChannel.TimecodeBurninSettingsProperty(
        font_size="fontSize",
        position="position",
        prefix="prefix"
    ),
    timecode_insertion="timecodeInsertion"
)

Attributes

adaptive_quantization

The adaptive quantization.

This allows intra-frame quantizers to vary to improve visual quality.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-adaptivequantization

afd_signaling

Indicates that AFD values will be written into the output stream.

If afdSignaling is auto, the system tries to preserve the input AFD value (in cases where multiple AFD values are valid). If set to fixed, the AFD value is the value configured in the fixedAfd parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-afdsignaling

bitrate

The average bitrate in bits/second.

This is required when the rate control mode is VBR or CBR. It isn’t used for QVBR. In a Microsoft Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-bitrate

buf_fill_pct

The percentage of the buffer that should initially be filled (HRD buffer model).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-buffillpct

buf_size

The size of the buffer (HRD buffer model) in bits/second.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-bufsize

color_metadata

Includes color space metadata in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-colormetadata

color_space_settings

Settings to configure the color space handling for the video.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-colorspacesettings

entropy_encoding

The entropy encoding mode.

Use cabac (must be in Main or High profile) or cavlc.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-entropyencoding

filter_settings

Optional filters that you can apply to an encode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-filtersettings

fixed_afd

A four-bit AFD value to write on all frames of video in the output stream.

Valid only when afdSignaling is set to Fixed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-fixedafd

flicker_aq

If set to enabled, adjusts the quantization within each frame to reduce flicker or pop on I-frames.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-flickeraq

force_field_pictures

Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-forcefieldpictures
Type:: This setting applies only when scan type is “interlaced.” It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.) enabled
Type:: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately. disabled

framerate_control

Indicates how the output video frame rate is specified.

If you select “specified,” the output video frame rate is determined by framerateNumerator and framerateDenominator. If you select “initializeFromSource,” the output video frame rate is set equal to the input video frame rate of the first input.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-frameratecontrol

framerate_denominator

The frame rate denominator.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-frameratedenominator

framerate_numerator

The frame rate numerator.

The frame rate is a fraction, for example, 24000/1001 = 23.976 fps.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-frameratenumerator

gop_b_reference

If enabled, uses reference B frames for GOP structures that have B frames > 1.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-gopbreference

gop_closed_cadence

The frequency of closed GOPs.

In streaming applications, we recommend that you set this to 1 so that a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-gopclosedcadence

gop_num_b_frames

The number of B-frames between reference frames.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-gopnumbframes

gop_size

The GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits.

The value must be greater than zero.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-gopsize

gop_size_units

Indicates if the gopSize is specified in frames or seconds.

If seconds, the system converts the gopSize into a frame count at runtime.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-gopsizeunits

level

The H.264 level.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-level

look_ahead_rate_control

The amount of lookahead.

A value of low can decrease latency and memory usage, while high can produce better quality for certain content.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-lookaheadratecontrol

max_bitrate

See the tooltip for Quality level.

For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-maxbitrate
Type:: For QVBR

min_i_interval

Meaningful only if sceneChangeDetect is set to enabled.

This setting enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting the I-interval. The normal cadence resumes for the next GOP. Note that the maximum GOP stretch = GOP size + Min-I-interval - 1.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-miniinterval

num_ref_frames

The number of reference frames to use.

The encoder might use more than requested if you use B-frames or interlaced encoding.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-numrefframes

par_control

Indicates how the output pixel aspect ratio is specified.

If “specified” is selected, the output video pixel aspect ratio is determined by parNumerator and parDenominator. If “initializeFromSource” is selected, the output pixels aspect ratio will be set equal to the input video pixel aspect ratio of the first input.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-parcontrol

par_denominator

The Pixel Aspect Ratio denominator.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-pardenominator

par_numerator

The Pixel Aspect Ratio numerator.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-parnumerator

profile

An H.264 profile.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-profile

quality_level

Leave as STANDARD_QUALITY or choose a different value (which might result in additional costs to run the channel).

ENHANCED_QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED_QUALITY.
STANDARD_QUALITY: Valid for any Rate control mode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-qualitylevel

qvbr_quality_level

Controls the target quality for the video encode.

This applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-qvbrqualitylevel

rate_control_mode

The rate control mode.

QVBR: The quality will match the specified quality level except when it is constrained by the maximum bitrate. We recommend this if you or your viewers pay for bandwidth. VBR: The quality and bitrate vary, depending on the video complexity. We recommend this instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: The quality varies, depending on the video complexity. We recommend this only if you distribute your assets to devices that can’t handle variable bitrates.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-ratecontrolmode

scan_type

Sets the scan type of the output to progressive or top-field-first interlaced.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-scantype

scene_change_detect

The scene change detection.

On: inserts I-frames when the scene change is detected. Off: does not force an I-frame when the scene change is detected.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-scenechangedetect

slices

The number of slices per picture.

The number must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional. If you don’t specify a value, MediaLive chooses the number of slices based on the encode resolution.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-slices

softness

Softness.

Selects a quantizer matrix. Larger values reduce high-frequency content in the encoded image.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-softness

spatial_aq

If set to enabled, adjusts quantization within each frame based on the spatial variation of content complexity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-spatialaq

subgop_length

If set to fixed, uses gopNumBFrames B-frames per sub-GOP.

If set to dynamic, optimizes the number of B-frames used for each sub-GOP to improve visual quality.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-subgoplength

syntax

Produces a bitstream that is compliant with SMPTE RP-2027.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-syntax

temporal_aq

If set to enabled, adjusts quantization within each frame based on the temporal variation of content complexity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-temporalaq

timecode_burnin_settings

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-timecodeburninsettings

Type:: see

timecode_insertion

Determines how timecodes should be inserted into the video elementary stream.

disabled: don’t include timecodes. picTimingSei: pass through picture timing SEI messages from the source specified in Timecode Config.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-timecodeinsertion

H265ColorSpaceSettingsProperty

class CfnChannel.H265ColorSpaceSettingsProperty(*, color_space_passthrough_settings=None, dolby_vision81_settings=None, hdr10_settings=None, rec601_settings=None, rec709_settings=None)

Bases: object

H265 Color Space Settings.

The parent of this entity is H265Settings.

Parameters:

color_space_passthrough_settings (Union[IResolvable, ColorSpacePassthroughSettingsProperty, Dict[str, Any], None]) – Passthrough applies no color space conversion to the output.
dolby_vision81_settings (Union[IResolvable, DolbyVision81SettingsProperty, Dict[str, Any], None]) –
hdr10_settings (Union[IResolvable, Hdr10SettingsProperty, Dict[str, Any], None]) – Settings to configure the handling of HDR10 color space.
rec601_settings (Union[IResolvable, Rec601SettingsProperty, Dict[str, Any], None]) – Settings to configure the handling of Rec601 color space.
rec709_settings (Union[IResolvable, Rec709SettingsProperty, Dict[str, Any], None]) – Settings to configure the handling of Rec709 color space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265colorspacesettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_medialive as medialive

h265_color_space_settings_property = medialive.CfnChannel.H265ColorSpaceSettingsProperty(
    color_space_passthrough_settings=medialive.CfnChannel.ColorSpacePassthroughSettingsProperty(),
    dolby_vision81_settings=medialive.CfnChannel.DolbyVision81SettingsProperty(),
    hdr10_settings=medialive.CfnChannel.Hdr10SettingsProperty(
        max_cll=123,
        max_fall=123
    ),
    rec601_settings=medialive.CfnChannel.Rec601SettingsProperty(),
    rec709_settings=medialive.CfnChannel.Rec709SettingsProperty()
)

Attributes

color_space_passthrough_settings

Passthrough applies no color space conversion to the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265colorspacesettings.html#cfn-medialive-channel-h265colorspacesettings-colorspacepassthroughsettings

dolby_vision81_settings

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265colorspacesettings.html#cfn-medialive-channel-h265colorspacesettings-dolbyvision81settings

Type:: see

hdr10_settings

Settings to configure the handling of HDR10 color space.

See: