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.Optional`\[: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:
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:
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:
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_normalization_settings=None, audio_selector_name=None, audio_type=None, audio_type_control=None, audio_watermarking_settings=None, codec_settings=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_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.

  • 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_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
        )
    ),
    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_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

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:
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:
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)

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.

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"
        )
    )
)

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

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:
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_selector_name=None, destination_settings=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_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.

  • 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_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"
        )
    ),
    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_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

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:
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:
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

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:
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:
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:
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:
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:

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

rec601_settings

Settings to configure the handling of Rec601 color space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265colorspacesettings.html#cfn-medialive-channel-h265colorspacesettings-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-h265colorspacesettings.html#cfn-medialive-channel-h265colorspacesettings-rec709settings

H265FilterSettingsProperty

class CfnChannel.H265FilterSettingsProperty(*, temporal_filter_settings=None)

Bases: object

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

The parent of this entity is H265Settings.

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-h265filtersettings.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_filter_settings_property = medialive.CfnChannel.H265FilterSettingsProperty(
    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-h265filtersettings.html#cfn-medialive-channel-h265filtersettings-temporalfiltersettings

H265SettingsProperty

class CfnChannel.H265SettingsProperty(*, adaptive_quantization=None, afd_signaling=None, alternative_transfer_function=None, bitrate=None, buf_size=None, color_metadata=None, color_space_settings=None, filter_settings=None, fixed_afd=None, flicker_aq=None, framerate_denominator=None, framerate_numerator=None, gop_closed_cadence=None, gop_size=None, gop_size_units=None, level=None, look_ahead_rate_control=None, max_bitrate=None, min_i_interval=None, par_denominator=None, par_numerator=None, profile=None, qvbr_quality_level=None, rate_control_mode=None, scan_type=None, scene_change_detect=None, slices=None, tier=None, timecode_burnin_settings=None, timecode_insertion=None)

Bases: object

H265 Settings.

The parent of this entity is VideoCodecSettings.

Parameters:
  • adaptive_quantization (Optional[str]) – Adaptive quantization. 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 will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to “fixed”, the AFD value will be the value configured in the fixedAfd parameter.

  • alternative_transfer_function (Optional[str]) – Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.

  • bitrate (Union[int, float, None]) – Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.

  • buf_size (Union[int, float, None]) – Size of buffer (HRD buffer model) in bits.

  • color_metadata (Optional[str]) – Includes colorspace metadata in the output.

  • color_space_settings (Union[IResolvable, H265ColorSpaceSettingsProperty, Dict[str, Any], None]) – Color Space settings.

  • filter_settings (Union[IResolvable, H265FilterSettingsProperty, Dict[str, Any], None]) – Optional filters that you can apply to an encode.

  • fixed_afd (Optional[str]) – Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to ‘Fixed’.

  • flicker_aq (Optional[str]) – If set to enabled, adjust quantization within each frame to reduce flicker or ‘pop’ on I-frames.

  • framerate_denominator (Union[int, float, None]) – Framerate denominator.

  • framerate_numerator (Union[int, float, None]) – Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.

  • gop_closed_cadence (Union[int, float, None]) – Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.

  • gop_size (Union[int, float, None]) – GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.

  • gop_size_units (Optional[str]) – Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.

  • level (Optional[str]) – H.265 Level.

  • look_ahead_rate_control (Optional[str]) – 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.

  • min_i_interval (Union[int, float, None]) – Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. 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 and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1

  • par_denominator (Union[int, float, None]) – Pixel Aspect Ratio denominator.

  • par_numerator (Union[int, float, None]) – Pixel Aspect Ratio numerator.

  • profile (Optional[str]) – H.265 Profile.

  • qvbr_quality_level (Union[int, float, None]) – Controls the target quality for the video encode. 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]) – Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program.

  • scan_type (Optional[str]) – Sets the scan type of the output to progressive or top-field-first interlaced.

  • scene_change_detect (Optional[str]) – Scene change detection.

  • slices (Union[int, float, None]) – Number of slices per picture. 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; when no value is specified the encoder will choose the number of slices based on encode resolution.

  • tier (Optional[str]) – H.265 Tier.

  • 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’: Do not 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-h265settings.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_settings_property = medialive.CfnChannel.H265SettingsProperty(
    adaptive_quantization="adaptiveQuantization",
    afd_signaling="afdSignaling",
    alternative_transfer_function="alternativeTransferFunction",
    bitrate=123,
    buf_size=123,
    color_metadata="colorMetadata",
    color_space_settings=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()
    ),
    filter_settings=medialive.CfnChannel.H265FilterSettingsProperty(
        temporal_filter_settings=medialive.CfnChannel.TemporalFilterSettingsProperty(
            post_filter_sharpening="postFilterSharpening",
            strength="strength"
        )
    ),
    fixed_afd="fixedAfd",
    flicker_aq="flickerAq",
    framerate_denominator=123,
    framerate_numerator=123,
    gop_closed_cadence=123,
    gop_size=123,
    gop_size_units="gopSizeUnits",
    level="level",
    look_ahead_rate_control="lookAheadRateControl",
    max_bitrate=123,
    min_iInterval=123,
    par_denominator=123,
    par_numerator=123,
    profile="profile",
    qvbr_quality_level=123,
    rate_control_mode="rateControlMode",
    scan_type="scanType",
    scene_change_detect="sceneChangeDetect",
    slices=123,
    tier="tier",
    timecode_burnin_settings=medialive.CfnChannel.TimecodeBurninSettingsProperty(
        font_size="fontSize",
        position="position",
        prefix="prefix"
    ),
    timecode_insertion="timecodeInsertion"
)

Attributes

adaptive_quantization

Adaptive quantization.

Allows intra-frame quantizers to vary to improve visual quality.

See:

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

afd_signaling

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

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

See:

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

alternative_transfer_function

Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.

See:

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

bitrate

Average bitrate in bits/second.

Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS 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-h265settings.html#cfn-medialive-channel-h265settings-bitrate

buf_size

Size of buffer (HRD buffer model) in bits.

See:

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

color_metadata

Includes colorspace metadata in the output.

See:

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

color_space_settings

Color Space settings.

See:

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

filter_settings

Optional filters that you can apply to an encode.

See:

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

fixed_afd

Four bit AFD value to write on all frames of video in the output stream.

Only valid when afdSignaling is set to ‘Fixed’.

See:

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

flicker_aq

If set to enabled, adjust 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-h265settings.html#cfn-medialive-channel-h265settings-flickeraq

framerate_denominator

Framerate denominator.

See:

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

framerate_numerator

Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.

See:

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

gop_closed_cadence

Frequency of closed GOPs.

In streaming applications, it is recommended that this be set to 1 so 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-h265settings.html#cfn-medialive-channel-h265settings-gopclosedcadence

gop_size

GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits.

If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.

See:

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

gop_size_units

Indicates if the gopSize is specified in frames or seconds.

If seconds the system will convert the gopSize into a frame count at run time.

See:

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

level

H.265 Level.

See:

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

look_ahead_rate_control

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-h265settings.html#cfn-medialive-channel-h265settings-lookaheadratecontrol

max_bitrate

See the tooltip for Quality level.

See:

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

Type:

For QVBR

min_i_interval

Only meaningful if sceneChangeDetect is set to enabled.

Defaults to 5 if multiplex rate control is used. 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 and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1

See:

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

par_denominator

Pixel Aspect Ratio denominator.

See:

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

par_numerator

Pixel Aspect Ratio numerator.

See:

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

profile

H.265 Profile.

See:

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

qvbr_quality_level

Controls the target quality for the video encode.

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-h265settings.html#cfn-medialive-channel-h265settings-qvbrqualitylevel

rate_control_mode

Rate control mode.

QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-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-h265settings.html#cfn-medialive-channel-h265settings-scantype

scene_change_detect

Scene change detection.

See:

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

slices

Number of slices per picture.

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; when no value is specified the encoder will choose the number of slices based on encode resolution.

See:

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

tier

H.265 Tier.

See:

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

timecode_burnin_settings

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

Type:

see

timecode_insertion

Determines how timecodes should be inserted into the video elementary stream.

  • ‘disabled’: Do not 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-h265settings.html#cfn-medialive-channel-h265settings-timecodeinsertion

Hdr10SettingsProperty

class CfnChannel.Hdr10SettingsProperty(*, max_cll=None, max_fall=None)

Bases: object

Hdr10 Settings.

The parents of this entity are H265ColorSpaceSettings (for color space settings in the output) and VideoSelectorColorSpaceSettings (for color space settings in the input).

Parameters:
  • max_cll (Union[int, float, None]) – Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file.

  • max_fall (Union[int, float, None]) – Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file.

See:

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

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

hdr10_settings_property = medialive.CfnChannel.Hdr10SettingsProperty(
    max_cll=123,
    max_fall=123
)

Attributes

max_cll

Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file.

See:

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

max_fall

Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file.

See:

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

HlsAkamaiSettingsProperty

class CfnChannel.HlsAkamaiSettingsProperty(*, connection_retry_interval=None, filecache_duration=None, http_transfer_mode=None, num_retries=None, restart_delay=None, salt=None, token=None)

Bases: object

The Akamai settings in an HLS output.

The parent of this entity is HlsCdnSettings.

Parameters:
  • connection_retry_interval (Union[int, float, None]) – The number of seconds to wait before retrying a connection to the CDN if the connection is lost.

  • filecache_duration (Union[int, float, None]) – The size, in seconds, of the file cache for streaming outputs.

  • http_transfer_mode (Optional[str]) – Specifies whether to use chunked transfer encoding to Akamai. To enable this feature, contact Akamai.

  • num_retries (Union[int, float, None]) – The number of retry attempts that will be made before the channel is put into an error state.

  • restart_delay (Union[int, float, None]) – If a streaming output fails, the number of seconds to wait until a restart is initiated. A value of 0 means never restart.

  • salt (Optional[str]) – The salt for authenticated Akamai.

  • token (Optional[str]) – The token parameter for authenticated Akamai. If this is not specified, gda is used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsakamaisettings.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

hls_akamai_settings_property = medialive.CfnChannel.HlsAkamaiSettingsProperty(
    connection_retry_interval=123,
    filecache_duration=123,
    http_transfer_mode="httpTransferMode",
    num_retries=123,
    restart_delay=123,
    salt="salt",
    token="token"
)

Attributes

connection_retry_interval

The number of seconds to wait before retrying a connection to the CDN if the connection is lost.

See:

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

filecache_duration

The size, in seconds, of the file cache for streaming outputs.

See:

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

http_transfer_mode

Specifies whether to use chunked transfer encoding to Akamai.

To enable this feature, contact Akamai.

See:

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

num_retries

The number of retry attempts that will be made before the channel is put into an error state.

See:

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

restart_delay

If a streaming output fails, the number of seconds to wait until a restart is initiated.

A value of 0 means never restart.

See:

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

salt

The salt for authenticated Akamai.

See:

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

token

The token parameter for authenticated Akamai.

If this is not specified, gda is used.

See:

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

HlsBasicPutSettingsProperty

class CfnChannel.HlsBasicPutSettingsProperty(*, connection_retry_interval=None, filecache_duration=None, num_retries=None, restart_delay=None)

Bases: object

The configuration of HLS Basic Put Settings.

The parent of this entity is HlsCdnSettings.

Parameters:
  • connection_retry_interval (Union[int, float, None]) – The number of seconds to wait before retrying a connection to the CDN if the connection is lost.

  • filecache_duration (Union[int, float, None]) – The size, in seconds, of the file cache for streaming outputs.

  • num_retries (Union[int, float, None]) – The number of retry attempts that MediaLive makes before the channel is put into an error state.

  • restart_delay (Union[int, float, None]) – If a streaming output fails, the number of seconds to wait until a restart is initiated. A value of 0 means never restart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsbasicputsettings.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

hls_basic_put_settings_property = medialive.CfnChannel.HlsBasicPutSettingsProperty(
    connection_retry_interval=123,
    filecache_duration=123,
    num_retries=123,
    restart_delay=123
)

Attributes

connection_retry_interval

The number of seconds to wait before retrying a connection to the CDN if the connection is lost.

See:

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

filecache_duration

The size, in seconds, of the file cache for streaming outputs.

See:

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

num_retries

The number of retry attempts that MediaLive makes before the channel is put into an error state.

See:

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

restart_delay

If a streaming output fails, the number of seconds to wait until a restart is initiated.

A value of 0 means never restart.

See:

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

HlsCdnSettingsProperty

class CfnChannel.HlsCdnSettingsProperty(*, hls_akamai_settings=None, hls_basic_put_settings=None, hls_media_store_settings=None, hls_s3_settings=None, hls_webdav_settings=None)

Bases: object

The settings for the CDN of an HLS output.

The parent of this entity is HlsGroupSettings.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlscdnsettings.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

hls_cdn_settings_property = medialive.CfnChannel.HlsCdnSettingsProperty(
    hls_akamai_settings=medialive.CfnChannel.HlsAkamaiSettingsProperty(
        connection_retry_interval=123,
        filecache_duration=123,
        http_transfer_mode="httpTransferMode",
        num_retries=123,
        restart_delay=123,
        salt="salt",
        token="token"
    ),
    hls_basic_put_settings=medialive.CfnChannel.HlsBasicPutSettingsProperty(
        connection_retry_interval=123,
        filecache_duration=123,
        num_retries=123,
        restart_delay=123
    ),
    hls_media_store_settings=medialive.CfnChannel.HlsMediaStoreSettingsProperty(
        connection_retry_interval=123,
        filecache_duration=123,
        media_store_storage_class="mediaStoreStorageClass",
        num_retries=123,
        restart_delay=123
    ),
    hls_s3_settings=medialive.CfnChannel.HlsS3SettingsProperty(
        canned_acl="cannedAcl"
    ),
    hls_webdav_settings=medialive.CfnChannel.HlsWebdavSettingsProperty(
        connection_retry_interval=123,
        filecache_duration=123,
        http_transfer_mode="httpTransferMode",
        num_retries=123,
        restart_delay=123
    )
)

Attributes

hls_akamai_settings

Sets up Akamai as the downstream system for the HLS output group.

See:

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

hls_basic_put_settings

The settings for Basic Put for the HLS output.

See:

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

hls_media_store_settings

Sets up MediaStore as the destination for the HLS output.

See:

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

hls_s3_settings

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

See:

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

hls_webdav_settings

The settings for Web VTT captions in the HLS output group.

The parent of this entity is HlsGroupSettings.

See:

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

HlsGroupSettingsProperty

class CfnChannel.HlsGroupSettingsProperty(*, ad_markers=None, base_url_content=None, base_url_content1=None, base_url_manifest=None, base_url_manifest1=None, caption_language_mappings=None, caption_language_setting=None, client_cache=None, codec_specification=None, constant_iv=None, destination=None, directory_structure=None, discontinuity_tags=None, encryption_type=None, hls_cdn_settings=None, hls_id3_segment_tagging=None, i_frame_only_playlists=None, incomplete_segment_behavior=None, index_n_segments=None, input_loss_action=None, iv_in_manifest=None, iv_source=None, keep_segments=None, key_format=None, key_format_versions=None, key_provider_settings=None, manifest_compression=None, manifest_duration_format=None, min_segment_length=None, mode=None, output_selection=None, program_date_time=None, program_date_time_clock=None, program_date_time_period=None, redundant_manifest=None, segmentation_mode=None, segment_length=None, segments_per_subdirectory=None, stream_inf_resolution=None, timed_metadata_id3_frame=None, timed_metadata_id3_period=None, timestamp_delta_milliseconds=None, ts_file_mode=None)

Bases: object

The settings for an HLS output group.

The parent of this entity is OutputGroupSettings.

Parameters:
  • ad_markers (Optional[Sequence[str]]) – Chooses one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.

  • base_url_content (Optional[str]) – A partial URI prefix that will be prepended to each output in the media .m3u8 file. The partial URI prefix can be used if the base manifest is delivered from a different URL than the main .m3u8 file.

  • base_url_content1 (Optional[str]) – Optional. One value per output group. This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0.

  • base_url_manifest (Optional[str]) – A partial URI prefix that will be prepended to each output in the media .m3u8 file. The partial URI prefix can be used if the base manifest is delivered from a different URL than the main .m3u8 file.

  • base_url_manifest1 (Optional[str]) – Optional. One value per output group. Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0.

  • caption_language_mappings (Union[IResolvable, Sequence[Union[IResolvable, CaptionLanguageMappingProperty, Dict[str, Any]]], None]) – A mapping of up to 4 captions channels to captions languages. This is meaningful only if captionLanguageSetting is set to “insert.”

  • caption_language_setting (Optional[str]) – Applies only to 608 embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code that you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the captions selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match properly with the output captions. None: Include the CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

  • client_cache (Optional[str]) – When set to “disabled,” sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.

  • codec_specification (Optional[str]) – The specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

  • constant_iv (Optional[str]) – Used with encryptionType. This is a 128-bit, 16-byte hex value that is represented by a 32-character text string. If ivSource is set to “explicit,” this parameter is required and is used as the IV for encryption.

  • destination (Union[IResolvable, OutputLocationRefProperty, Dict[str, Any], None]) – A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).

  • directory_structure (Optional[str]) – Places segments in subdirectories.

  • discontinuity_tags (Optional[str]) – Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group. Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags.

  • encryption_type (Optional[str]) – Encrypts the segments with the specified encryption scheme. Exclude this parameter if you don’t want encryption.

  • hls_cdn_settings (Union[IResolvable, HlsCdnSettingsProperty, Dict[str, Any], None]) – The parameters that control interactions with the CDN.

  • hls_id3_segment_tagging (Optional[str]) – State of HLS ID3 Segment Tagging.

  • i_frame_only_playlists (Optional[str]) – DISABLED: Don’t create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888”.

  • incomplete_segment_behavior (Optional[str]) – Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline. Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior.

  • index_n_segments (Union[int, float, None]) – Applies only if the Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.

  • input_loss_action (Optional[str]) – A parameter that controls output group behavior on an input loss.

  • iv_in_manifest (Optional[str]) – Used with encryptionType. The IV (initialization vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to “include,” the IV is listed in the manifest. Otherwise, the IV is not in the manifest.

  • iv_source (Optional[str]) – Used with encryptionType. The IV (initialization vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is “followsSegmentNumber,” it causes the IV to change every segment (to match the segment number). If this is set to “explicit,” you must enter a constantIv value.

  • keep_segments (Union[int, float, None]) – Applies only if the Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.

  • key_format (Optional[str]) – Specifies how the key is represented in the resource identified by the URI. If the parameter is absent, an implicit value of “identity” is used. A reverse DNS string can also be specified.

  • key_format_versions (Optional[str]) – Either a single positive integer version value or a slash-delimited list of version values (1/2/3).

  • key_provider_settings (Union[IResolvable, KeyProviderSettingsProperty, Dict[str, Any], None]) – The key provider settings.

  • manifest_compression (Optional[str]) – When set to gzip, compresses HLS playlist.

  • manifest_duration_format (Optional[str]) – Indicates whether the output manifest should use a floating point or integer values for segment duration.

  • min_segment_length (Union[int, float, None]) – When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.

  • mode (Optional[str]) – If “vod,” all segments are indexed and kept permanently in the destination and manifest. If “live,” only the number segments specified in keepSegments and indexNSegments are kept. Newer segments replace older segments, which might prevent players from rewinding all the way to the beginning of the channel. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a “VOD” type manifest on completion of the stream.

  • output_selection (Optional[str]) – MANIFESTSANDSEGMENTS: Generates manifests (the master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Doesn’t generate any manifests for this output group.

  • program_date_time (Optional[str]) – Includes or excludes the EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: Either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.

  • program_date_time_clock (Optional[str]) – Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include: INITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment. SYSTEM_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock.

  • program_date_time_period (Union[int, float, None]) – The period of insertion of the EXT-X-PROGRAM-DATE-TIME entry, in seconds.

  • redundant_manifest (Optional[str]) – ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows a playout device that supports stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players, so a redundant manifest from MediaLive is irrelevant.

  • segmentation_mode (Optional[str]) – useInputSegmentation has been deprecated. The configured segment size is always used.

  • segment_length (Union[int, float, None]) – The length of the MPEG-2 Transport Stream segments to create, in seconds. Note that segments will end on the next keyframe after this number of seconds, so the actual segment length might be longer.

  • segments_per_subdirectory (Union[int, float, None]) – The number of segments to write to a subdirectory before starting a new one. For this setting to have an effect, directoryStructure must be subdirectoryPerStream.

  • stream_inf_resolution (Optional[str]) – The include or exclude RESOLUTION attribute for a video in the EXT-X-STREAM-INF tag of a variant manifest.

  • timed_metadata_id3_frame (Optional[str]) – Indicates the ID3 frame that has the timecode.

  • timed_metadata_id3_period (Union[int, float, None]) – The timed metadata interval, in seconds.

  • timestamp_delta_milliseconds (Union[int, float, None]) – Provides an extra millisecond delta offset to fine tune the timestamps.

  • ts_file_mode (Optional[str]) – SEGMENTEDFILES: Emits the program as segments -multiple .ts media files. SINGLEFILE: Applies only if the Mode field is VOD. Emits the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.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

hls_group_settings_property = medialive.CfnChannel.HlsGroupSettingsProperty(
    ad_markers=["adMarkers"],
    base_url_content="baseUrlContent",
    base_url_content1="baseUrlContent1",
    base_url_manifest="baseUrlManifest",
    base_url_manifest1="baseUrlManifest1",
    caption_language_mappings=[medialive.CfnChannel.CaptionLanguageMappingProperty(
        caption_channel=123,
        language_code="languageCode",
        language_description="languageDescription"
    )],
    caption_language_setting="captionLanguageSetting",
    client_cache="clientCache",
    codec_specification="codecSpecification",
    constant_iv="constantIv",
    destination=medialive.CfnChannel.OutputLocationRefProperty(
        destination_ref_id="destinationRefId"
    ),
    directory_structure="directoryStructure",
    discontinuity_tags="discontinuityTags",
    encryption_type="encryptionType",
    hls_cdn_settings=medialive.CfnChannel.HlsCdnSettingsProperty(
        hls_akamai_settings=medialive.CfnChannel.HlsAkamaiSettingsProperty(
            connection_retry_interval=123,
            filecache_duration=123,
            http_transfer_mode="httpTransferMode",
            num_retries=123,
            restart_delay=123,
            salt="salt",
            token="token"
        ),
        hls_basic_put_settings=medialive.CfnChannel.HlsBasicPutSettingsProperty(
            connection_retry_interval=123,
            filecache_duration=123,
            num_retries=123,
            restart_delay=123
        ),
        hls_media_store_settings=medialive.CfnChannel.HlsMediaStoreSettingsProperty(
            connection_retry_interval=123,
            filecache_duration=123,
            media_store_storage_class="mediaStoreStorageClass",
            num_retries=123,
            restart_delay=123
        ),
        hls_s3_settings=medialive.CfnChannel.HlsS3SettingsProperty(
            canned_acl="cannedAcl"
        ),
        hls_webdav_settings=medialive.CfnChannel.HlsWebdavSettingsProperty(
            connection_retry_interval=123,
            filecache_duration=123,
            http_transfer_mode="httpTransferMode",
            num_retries=123,
            restart_delay=123
        )
    ),
    hls_id3_segment_tagging="hlsId3SegmentTagging",
    i_frame_only_playlists="iFrameOnlyPlaylists",
    incomplete_segment_behavior="incompleteSegmentBehavior",
    index_nSegments=123,
    input_loss_action="inputLossAction",
    iv_in_manifest="ivInManifest",
    iv_source="ivSource",
    keep_segments=123,
    key_format="keyFormat",
    key_format_versions="keyFormatVersions",
    key_provider_settings=medialive.CfnChannel.KeyProviderSettingsProperty(
        static_key_settings=medialive.CfnChannel.StaticKeySettingsProperty(
            key_provider_server=medialive.CfnChannel.InputLocationProperty(
                password_param="passwordParam",
                uri="uri",
                username="username"
            ),
            static_key_value="staticKeyValue"
        )
    ),
    manifest_compression="manifestCompression",
    manifest_duration_format="manifestDurationFormat",
    min_segment_length=123,
    mode="mode",
    output_selection="outputSelection",
    program_date_time="programDateTime",
    program_date_time_clock="programDateTimeClock",
    program_date_time_period=123,
    redundant_manifest="redundantManifest",
    segmentation_mode="segmentationMode",
    segment_length=123,
    segments_per_subdirectory=123,
    stream_inf_resolution="streamInfResolution",
    timed_metadata_id3_frame="timedMetadataId3Frame",
    timed_metadata_id3_period=123,
    timestamp_delta_milliseconds=123,
    ts_file_mode="tsFileMode"
)

Attributes

ad_markers

Chooses one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.

See:

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

base_url_content

A partial URI prefix that will be prepended to each output in the media .m3u8 file. The partial URI prefix can be used if the base manifest is delivered from a different URL than the main .m3u8 file.

See:

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

base_url_content1

Optional.

One value per output group. This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0.

See:

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

base_url_manifest

A partial URI prefix that will be prepended to each output in the media .m3u8 file. The partial URI prefix can be used if the base manifest is delivered from a different URL than the main .m3u8 file.

See:

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

base_url_manifest1

Optional.

One value per output group. Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0.

See:

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

caption_language_mappings

A mapping of up to 4 captions channels to captions languages.

This is meaningful only if captionLanguageSetting is set to “insert.”

See:

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

caption_language_setting

Applies only to 608 embedded output captions.

Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code that you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the captions selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match properly with the output captions. None: Include the CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

See:

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

client_cache

no tag in the manifest, which prevents clients from saving media segments for later replay.

See:

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

Type:

When set to “disabled,” sets the #EXT-X-ALLOW-CACHE

codec_specification

The specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

See:

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

constant_iv

Used with encryptionType.

This is a 128-bit, 16-byte hex value that is represented by a 32-character text string. If ivSource is set to “explicit,” this parameter is required and is used as the IV for encryption.

See:

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

destination

A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).

See:

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

directory_structure

Places segments in subdirectories.

See:

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

discontinuity_tags

Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group.

Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags.

See:

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

encryption_type

Encrypts the segments with the specified encryption scheme.

Exclude this parameter if you don’t want encryption.

See:

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

hls_cdn_settings

The parameters that control interactions with the CDN.

See:

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

hls_id3_segment_tagging

State of HLS ID3 Segment Tagging.

See:

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

i_frame_only_playlists

Don’t create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).

STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888”.

See:

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

Type:

DISABLED

incomplete_segment_behavior

Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline.

Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior.

See:

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

index_n_segments

Applies only if the Mode field is LIVE.

Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.

See:

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

input_loss_action

A parameter that controls output group behavior on an input loss.

See:

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

iv_in_manifest

Used with encryptionType.

The IV (initialization vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to “include,” the IV is listed in the manifest. Otherwise, the IV is not in the manifest.

See:

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

iv_source

Used with encryptionType.

The IV (initialization vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is “followsSegmentNumber,” it causes the IV to change every segment (to match the segment number). If this is set to “explicit,” you must enter a constantIv value.

See:

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

keep_segments

Applies only if the Mode field is LIVE.

Specifies the number of media segments (.ts files) to retain in the destination directory.

See:

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

key_format

Specifies how the key is represented in the resource identified by the URI.

If the parameter is absent, an implicit value of “identity” is used. A reverse DNS string can also be specified.

See:

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

key_format_versions

Either a single positive integer version value or a slash-delimited list of version values (1/2/3).

See:

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

key_provider_settings

The key provider settings.

See:

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

manifest_compression

When set to gzip, compresses HLS playlist.

See:

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

manifest_duration_format

Indicates whether the output manifest should use a floating point or integer values for segment duration.

See:

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

min_segment_length

When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.

See:

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

mode

If “vod,” all segments are indexed and kept permanently in the destination and manifest.

If “live,” only the number segments specified in keepSegments and indexNSegments are kept. Newer segments replace older segments, which might prevent players from rewinding all the way to the beginning of the channel. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a “VOD” type manifest on completion of the stream.

See:

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

output_selection

Generates manifests (the master manifest, if applicable, and media manifests) for this output group.

SEGMENTSONLY: Doesn’t generate any manifests for this output group.

See:

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

Type:

MANIFESTSANDSEGMENTS

program_date_time

Either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.

See:

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

Type:

Includes or excludes the EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows

program_date_time_clock

Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock.

Options include: INITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment. SYSTEM_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock.

See:

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

program_date_time_period

The period of insertion of the EXT-X-PROGRAM-DATE-TIME entry, in seconds.

See:

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

redundant_manifest

first its own media files, then the media files of the other pipeline. This feature allows a playout device that supports stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players, so a redundant manifest from MediaLive is irrelevant.

See:

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

Type:

ENABLED

Type:

The master manifest (.m3u8 file) for each pipeline includes information about both pipelines

segment_length

The length of the MPEG-2 Transport Stream segments to create, in seconds.

Note that segments will end on the next keyframe after this number of seconds, so the actual segment length might be longer.

See:

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

segmentation_mode

useInputSegmentation has been deprecated.

The configured segment size is always used.

See:

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

segments_per_subdirectory

The number of segments to write to a subdirectory before starting a new one.

For this setting to have an effect, directoryStructure must be subdirectoryPerStream.

See:

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

stream_inf_resolution

The include or exclude RESOLUTION attribute for a video in the EXT-X-STREAM-INF tag of a variant manifest.

See:

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

timed_metadata_id3_frame

Indicates the ID3 frame that has the timecode.

See:

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

timed_metadata_id3_period

The timed metadata interval, in seconds.

See:

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

timestamp_delta_milliseconds

Provides an extra millisecond delta offset to fine tune the timestamps.

See:

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

ts_file_mode

Applies only if the Mode field is VOD. Emits the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.

See:

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

Type:

SEGMENTEDFILES

Type:

Emits the program as segments -multiple .ts media files. SINGLEFILE

HlsInputSettingsProperty

class CfnChannel.HlsInputSettingsProperty(*, bandwidth=None, buffer_segments=None, retries=None, retry_interval=None, scte35_source=None)

Bases: object

Information about how to connect to the upstream system.

The parent of this entity is NetworkInputSettings.

Parameters:
  • bandwidth (Union[int, float, None]) – When specified, the HLS stream with the m3u8 bandwidth that most closely matches this value is chosen. Otherwise, the highest bandwidth stream in the m3u8 is chosen. The bitrate is specified in bits per second, as in an HLS manifest.

  • buffer_segments (Union[int, float, None]) – When specified, reading of the HLS input begins this many buffer segments from the end (most recently written segment). When not specified, the HLS input begins with the first segment specified in the m3u8.

  • retries (Union[int, float, None]) – The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.

  • retry_interval (Union[int, float, None]) – The number of seconds between retries when an attempt to read a manifest or segment fails.

  • scte35_source (Optional[str]) – Identifies the source for the SCTE-35 messages that MediaLive will ingest. Messages can be ingested from the content segments (in the stream) or from tags in the playlist (the HLS manifest). MediaLive ignores SCTE-35 information in the source that is not selected.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsinputsettings.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

hls_input_settings_property = medialive.CfnChannel.HlsInputSettingsProperty(
    bandwidth=123,
    buffer_segments=123,
    retries=123,
    retry_interval=123,
    scte35_source="scte35Source"
)

Attributes

bandwidth

When specified, the HLS stream with the m3u8 bandwidth that most closely matches this value is chosen.

Otherwise, the highest bandwidth stream in the m3u8 is chosen. The bitrate is specified in bits per second, as in an HLS manifest.

See:

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

buffer_segments

When specified, reading of the HLS input begins this many buffer segments from the end (most recently written segment).

When not specified, the HLS input begins with the first segment specified in the m3u8.

See:

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

retries

The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.

See:

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

retry_interval

The number of seconds between retries when an attempt to read a manifest or segment fails.

See:

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

scte35_source

Identifies the source for the SCTE-35 messages that MediaLive will ingest.

Messages can be ingested from the content segments (in the stream) or from tags in the playlist (the HLS manifest). MediaLive ignores SCTE-35 information in the source that is not selected.

See:

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

HlsMediaStoreSettingsProperty

class CfnChannel.HlsMediaStoreSettingsProperty(*, connection_retry_interval=None, filecache_duration=None, media_store_storage_class=None, num_retries=None, restart_delay=None)

Bases: object

The configuration of a MediaStore container as the destination for an HLS output.

The parent of this entity is HlsCdnSettings.

Parameters:
  • connection_retry_interval (Union[int, float, None]) – The number of seconds to wait before retrying a connection to the CDN if the connection is lost.

  • filecache_duration (Union[int, float, None]) – The size, in seconds, of the file cache for streaming outputs.

  • media_store_storage_class (Optional[str]) – When set to temporal, output files are stored in non-persistent memory for faster reading and writing.

  • num_retries (Union[int, float, None]) – The number of retry attempts that are made before the channel is put into an error state.

  • restart_delay (Union[int, float, None]) – If a streaming output fails, the number of seconds to wait until a restart is initiated. A value of 0 means never restart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsmediastoresettings.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

hls_media_store_settings_property = medialive.CfnChannel.HlsMediaStoreSettingsProperty(
    connection_retry_interval=123,
    filecache_duration=123,
    media_store_storage_class="mediaStoreStorageClass",
    num_retries=123,
    restart_delay=123
)

Attributes

connection_retry_interval

The number of seconds to wait before retrying a connection to the CDN if the connection is lost.

See:

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

filecache_duration

The size, in seconds, of the file cache for streaming outputs.

See:

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

media_store_storage_class

When set to temporal, output files are stored in non-persistent memory for faster reading and writing.

See:

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

num_retries

The number of retry attempts that are made before the channel is put into an error state.

See:

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

restart_delay

If a streaming output fails, the number of seconds to wait until a restart is initiated.

A value of 0 means never restart.

See:

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

HlsOutputSettingsProperty

class CfnChannel.HlsOutputSettingsProperty(*, h265_packaging_type=None, hls_settings=None, name_modifier=None, segment_modifier=None)

Bases: object

The settings for an HLS output.

The parent of this entity is OutputSettings.

Parameters:
  • h265_packaging_type (Optional[str]) – Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.

  • hls_settings (Union[IResolvable, HlsSettingsProperty, Dict[str, Any], None]) – The settings regarding the underlying stream. These settings are different for audio-only outputs.

  • name_modifier (Optional[str]) – A string that is concatenated to the end of the destination file name. Accepts “Format Identifiers”:#formatIdentifierParameters.

  • segment_modifier (Optional[str]) – A string that is concatenated to the end of segment file names.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsoutputsettings.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

hls_output_settings_property = medialive.CfnChannel.HlsOutputSettingsProperty(
    h265_packaging_type="h265PackagingType",
    hls_settings=medialive.CfnChannel.HlsSettingsProperty(
        audio_only_hls_settings=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"
        ),
        fmp4_hls_settings=medialive.CfnChannel.Fmp4HlsSettingsProperty(
            audio_rendition_sets="audioRenditionSets",
            nielsen_id3_behavior="nielsenId3Behavior",
            timed_metadata_behavior="timedMetadataBehavior"
        ),
        frame_capture_hls_settings=medialive.CfnChannel.FrameCaptureHlsSettingsProperty(),
        standard_hls_settings=medialive.CfnChannel.StandardHlsSettingsProperty(
            audio_rendition_sets="audioRenditionSets",
            m3_u8_settings=medialive.CfnChannel.M3u8SettingsProperty(
                audio_frames_per_pes=123,
                audio_pids="audioPids",
                ecm_pid="ecmPid",
                klv_behavior="klvBehavior",
                klv_data_pids="klvDataPids",
                nielsen_id3_behavior="nielsenId3Behavior",
                pat_interval=123,
                pcr_control="pcrControl",
                pcr_period=123,
                pcr_pid="pcrPid",
                pmt_interval=123,
                pmt_pid="pmtPid",
                program_num=123,
                scte35_behavior="scte35Behavior",
                scte35_pid="scte35Pid",
                timed_metadata_behavior="timedMetadataBehavior",
                timed_metadata_pid="timedMetadataPid",
                transport_stream_id=123,
                video_pid="videoPid"
            )
        )
    ),
    name_modifier="nameModifier",
    segment_modifier="segmentModifier"
)

Attributes

h265_packaging_type

Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.

See:

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

hls_settings

The settings regarding the underlying stream.

These settings are different for audio-only outputs.

See:

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

name_modifier

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

Accepts “Format Identifiers”:#formatIdentifierParameters.

See:

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

segment_modifier

A string that is concatenated to the end of segment file names.

See:

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

HlsS3SettingsProperty

class CfnChannel.HlsS3SettingsProperty(*, canned_acl=None)

Bases: object

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

The parent of this entity is HlsCdnSettings.

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-hlss3settings.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

hls_s3_settings_property = medialive.CfnChannel.HlsS3SettingsProperty(
    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-hlss3settings.html#cfn-medialive-channel-hlss3settings-cannedacl

HlsSettingsProperty

class CfnChannel.HlsSettingsProperty(*, audio_only_hls_settings=None, fmp4_hls_settings=None, frame_capture_hls_settings=None, standard_hls_settings=None)

Bases: object

The settings for an HLS output.

The parent of this entity is HlsOutputSettings.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlssettings.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

hls_settings_property = medialive.CfnChannel.HlsSettingsProperty(
    audio_only_hls_settings=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"
    ),
    fmp4_hls_settings=medialive.CfnChannel.Fmp4HlsSettingsProperty(
        audio_rendition_sets="audioRenditionSets",
        nielsen_id3_behavior="nielsenId3Behavior",
        timed_metadata_behavior="timedMetadataBehavior"
    ),
    frame_capture_hls_settings=medialive.CfnChannel.FrameCaptureHlsSettingsProperty(),
    standard_hls_settings=medialive.CfnChannel.StandardHlsSettingsProperty(
        audio_rendition_sets="audioRenditionSets",
        m3_u8_settings=medialive.CfnChannel.M3u8SettingsProperty(
            audio_frames_per_pes=123,
            audio_pids="audioPids",
            ecm_pid="ecmPid",
            klv_behavior="klvBehavior",
            klv_data_pids="klvDataPids",
            nielsen_id3_behavior="nielsenId3Behavior",
            pat_interval=123,
            pcr_control="pcrControl",
            pcr_period=123,
            pcr_pid="pcrPid",
            pmt_interval=123,
            pmt_pid="pmtPid",
            program_num=123,
            scte35_behavior="scte35Behavior",
            scte35_pid="scte35Pid",
            timed_metadata_behavior="timedMetadataBehavior",
            timed_metadata_pid="timedMetadataPid",
            transport_stream_id=123,
            video_pid="videoPid"
        )
    )
)

Attributes

audio_only_hls_settings

The settings for an audio-only output.

See:

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

fmp4_hls_settings

The settings for an fMP4 container.

See:

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

frame_capture_hls_settings

Settings for a frame capture output in an HLS output group.

See:

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

standard_hls_settings

The settings for a standard output (an output that is not audio-only).

See:

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

HlsWebdavSettingsProperty

class CfnChannel.HlsWebdavSettingsProperty(*, connection_retry_interval=None, filecache_duration=None, http_transfer_mode=None, num_retries=None, restart_delay=None)

Bases: object

The configuration of a WebDav server as the downstream system for an HLS output.

The parent of this entity is HlsCdnSettings.

Parameters:
  • connection_retry_interval (Union[int, float, None]) – The number of seconds to wait before retrying a connection to the CDN if the connection is lost.

  • filecache_duration (Union[int, float, None]) – The size, in seconds, of the file cache for streaming outputs.

  • http_transfer_mode (Optional[str]) – Specifies whether to use chunked transfer encoding to WebDAV.

  • num_retries (Union[int, float, None]) – The number of retry attempts that are made before the channel is put into an error state.

  • restart_delay (Union[int, float, None]) – If a streaming output fails, the number of seconds to wait until a restart is initiated. A value of 0 means never restart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlswebdavsettings.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

hls_webdav_settings_property = medialive.CfnChannel.HlsWebdavSettingsProperty(
    connection_retry_interval=123,
    filecache_duration=123,
    http_transfer_mode="httpTransferMode",
    num_retries=123,
    restart_delay=123
)

Attributes

connection_retry_interval

The number of seconds to wait before retrying a connection to the CDN if the connection is lost.

See:

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

filecache_duration

The size, in seconds, of the file cache for streaming outputs.

See:

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

http_transfer_mode

Specifies whether to use chunked transfer encoding to WebDAV.

See:

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

num_retries

The number of retry attempts that are made before the channel is put into an error state.

See:

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

restart_delay

If a streaming output fails, the number of seconds to wait until a restart is initiated.

A value of 0 means never restart.

See:

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

HtmlMotionGraphicsSettingsProperty

class CfnChannel.HtmlMotionGraphicsSettingsProperty

Bases: object

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-htmlmotiongraphicssettings.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

html_motion_graphics_settings_property = medialive.CfnChannel.HtmlMotionGraphicsSettingsProperty()

InputAttachmentProperty

class CfnChannel.InputAttachmentProperty(*, automatic_input_failover_settings=None, input_attachment_name=None, input_id=None, input_settings=None)

Bases: object

An input to attach to this channel.

This entity is at the top level in the channel.

Parameters:
  • automatic_input_failover_settings (Union[IResolvable, AutomaticInputFailoverSettingsProperty, Dict[str, Any], None]) – Settings to implement automatic input failover in this input.

  • input_attachment_name (Optional[str]) – A name for the attachment. This is required if you want to use this input in an input switch action.

  • input_id (Optional[str]) – The ID of the input to attach.

  • input_settings (Union[IResolvable, InputSettingsProperty, Dict[str, Any], None]) – Information about the content to extract from the input and about the general handling of the content.

See:

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

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

input_attachment_property = medialive.CfnChannel.InputAttachmentProperty(
    automatic_input_failover_settings=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"
    ),
    input_attachment_name="inputAttachmentName",
    input_id="inputId",
    input_settings=medialive.CfnChannel.InputSettingsProperty(
        audio_selectors=[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
                    )]
                )
            )
        )],
        caption_selectors=[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"
                )
            )
        )],
        deblock_filter="deblockFilter",
        denoise_filter="denoiseFilter",
        filter_strength=123,
        input_filter="inputFilter",
        network_input_settings=medialive.CfnChannel.NetworkInputSettingsProperty(
            hls_input_settings=medialive.CfnChannel.HlsInputSettingsProperty(
                bandwidth=123,
                buffer_segments=123,
                retries=123,
                retry_interval=123,
                scte35_source="scte35Source"
            ),
            server_validation="serverValidation"
        ),
        scte35_pid=123,
        smpte2038_data_preference="smpte2038DataPreference",
        source_end_behavior="sourceEndBehavior",
        video_selector=medialive.CfnChannel.VideoSelectorProperty(
            color_space="colorSpace",
            color_space_settings=medialive.CfnChannel.VideoSelectorColorSpaceSettingsProperty(
                hdr10_settings=medialive.CfnChannel.Hdr10SettingsProperty(
                    max_cll=123,
                    max_fall=123
                )
            ),
            color_space_usage="colorSpaceUsage",
            selector_settings=medialive.CfnChannel.VideoSelectorSettingsProperty(
                video_selector_pid=medialive.CfnChannel.VideoSelectorPidProperty(
                    pid=123
                ),
                video_selector_program_id=medialive.CfnChannel.VideoSelectorProgramIdProperty(
                    program_id=123
                )
            )
        )
    )
)

Attributes

automatic_input_failover_settings

Settings to implement automatic input failover in this input.

See:

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

input_attachment_name

A name for the attachment.

This is required if you want to use this input in an input switch action.

See:

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

input_id

The ID of the input to attach.

See:

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

input_settings

Information about the content to extract from the input and about the general handling of the content.

See:

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

InputChannelLevelProperty

class CfnChannel.InputChannelLevelProperty(*, gain=None, input_channel=None)

Bases: object

The setting to remix the audio.

The parent of this entity is AudioChannelMappings.

Parameters:
  • gain (Union[int, float, None]) – The remixing value. Units are in dB, and acceptable values are within the range from -60 (mute) to 6 dB.

  • input_channel (Union[int, float, None]) – The index of the input channel that is used as a source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputchannellevel.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

input_channel_level_property = medialive.CfnChannel.InputChannelLevelProperty(
    gain=123,
    input_channel=123
)

Attributes

gain

The remixing value.

Units are in dB, and acceptable values are within the range from -60 (mute) to 6 dB.

See:

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

input_channel

The index of the input channel that is used as a source.

See:

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

InputLocationProperty

class CfnChannel.InputLocationProperty(*, password_param=None, uri=None, username=None)

Bases: object

The input location.

The parent of this entity is InputLossBehavior.

Parameters:
  • password_param (Optional[str]) – The password parameter that holds the password for accessing the downstream system. This applies only if the downstream system requires credentials.

  • uri (Optional[str]) – The URI should be a path to a file that is accessible to the Live system (for example, an http:// URI) depending on the output type. For example, an RTMP destination should have a URI similar to rtmp://fmsserver/live.

  • username (Optional[str]) – The user name to connect to the downstream system. This applies only if the downstream system requires credentials.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlocation.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

input_location_property = medialive.CfnChannel.InputLocationProperty(
    password_param="passwordParam",
    uri="uri",
    username="username"
)

Attributes

password_param

The password parameter that holds the password for accessing the downstream system.

This applies only if the downstream system requires credentials.

See:

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

uri

// URI) depending on the output type.

For example, an RTMP destination should have a URI similar to rtmp://fmsserver/live.

See:

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

Type:

The URI should be a path to a file that is accessible to the Live system (for example, an http

username

The user name to connect to the downstream system.

This applies only if the downstream system requires credentials.

See:

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

InputLossBehaviorProperty

class CfnChannel.InputLossBehaviorProperty(*, black_frame_msec=None, input_loss_image_color=None, input_loss_image_slate=None, input_loss_image_type=None, repeat_frame_msec=None)

Bases: object

The configuration of channel behavior when the input is lost.

The parent of this entity is GlobalConfiguration.

Parameters:
  • black_frame_msec (Union[int, float, None]) – On input loss, the number of milliseconds to substitute black into the output before switching to the frame specified by inputLossImageType. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000, is interpreted as infinite.

  • input_loss_image_color (Optional[str]) – When the input loss image type is “color,” this field specifies the color to use. Value: 6 hex characters that represent the values of RGB.

  • input_loss_image_slate (Union[IResolvable, InputLocationProperty, Dict[str, Any], None]) – When the input loss image type is “slate,” these fields specify the parameters for accessing the slate.

  • input_loss_image_type (Optional[str]) – Indicates whether to substitute a solid color or a slate into the output after the input loss exceeds blackFrameMsec.

  • repeat_frame_msec (Union[int, float, None]) – On input loss, the number of milliseconds to repeat the previous picture before substituting black into the output. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000, is interpreted as infinite.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlossbehavior.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

input_loss_behavior_property = 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
)

Attributes

black_frame_msec

On input loss, the number of milliseconds to substitute black into the output before switching to the frame specified by inputLossImageType.

A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000, is interpreted as infinite.

See:

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

input_loss_image_color

When the input loss image type is “color,” this field specifies the color to use.

Value: 6 hex characters that represent the values of RGB.

See:

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

input_loss_image_slate

When the input loss image type is “slate,” these fields specify the parameters for accessing the slate.

See:

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

input_loss_image_type

Indicates whether to substitute a solid color or a slate into the output after the input loss exceeds blackFrameMsec.

See:

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

repeat_frame_msec

On input loss, the number of milliseconds to repeat the previous picture before substituting black into the output.

A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000, is interpreted as infinite.

See:

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

InputLossFailoverSettingsProperty

class CfnChannel.InputLossFailoverSettingsProperty(*, input_loss_threshold_msec=None)

Bases: object

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

The parent of this entity is FailoverConditionSettings.

Parameters:

input_loss_threshold_msec (Union[int, float, None]) – The amount of time (in milliseconds) that no input is detected. After that time, an input failover will occur.

See:

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

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

input_loss_failover_settings_property = medialive.CfnChannel.InputLossFailoverSettingsProperty(
    input_loss_threshold_msec=123
)

Attributes

input_loss_threshold_msec

The amount of time (in milliseconds) that no input is detected.

After that time, an input failover will occur.

See:

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

InputSettingsProperty

class CfnChannel.InputSettingsProperty(*, audio_selectors=None, caption_selectors=None, deblock_filter=None, denoise_filter=None, filter_strength=None, input_filter=None, network_input_settings=None, scte35_pid=None, smpte2038_data_preference=None, source_end_behavior=None, video_selector=None)

Bases: object

Information about extracting content from the input and about handling the content.

The parent of this entity is InputAttachment.

Parameters:
  • audio_selectors (Union[IResolvable, Sequence[Union[IResolvable, AudioSelectorProperty, Dict[str, Any]]], None]) – Information about the specific audio to extract from the input. The parent of this entity is InputSettings.

  • caption_selectors (Union[IResolvable, Sequence[Union[IResolvable, CaptionSelectorProperty, Dict[str, Any]]], None]) – Information about the specific captions to extract from the input.

  • deblock_filter (Optional[str]) – Enables or disables the deblock filter when filtering.

  • denoise_filter (Optional[str]) – Enables or disables the denoise filter when filtering.

  • filter_strength (Union[int, float, None]) – Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).

  • input_filter (Optional[str]) – Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering is applied depending on input type/quality 2) disabled - no filtering is applied to the input 3) forced - filtering is applied regardless of the input type.

  • network_input_settings (Union[IResolvable, NetworkInputSettingsProperty, Dict[str, Any], None]) – Information about how to connect to the upstream system.

  • scte35_pid (Union[int, float, None]) –

  • smpte2038_data_preference (Optional[str]) – Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages. - PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any). - IGNORE: Never extract any ancillary data from SMPTE-2038.

  • source_end_behavior (Optional[str]) – The loop input if it is a file.

  • video_selector (Union[IResolvable, VideoSelectorProperty, Dict[str, Any], None]) – Information about one video to extract from the input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.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

input_settings_property = medialive.CfnChannel.InputSettingsProperty(
    audio_selectors=[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
                )]
            )
        )
    )],
    caption_selectors=[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"
            )
        )
    )],
    deblock_filter="deblockFilter",
    denoise_filter="denoiseFilter",
    filter_strength=123,
    input_filter="inputFilter",
    network_input_settings=medialive.CfnChannel.NetworkInputSettingsProperty(
        hls_input_settings=medialive.CfnChannel.HlsInputSettingsProperty(
            bandwidth=123,
            buffer_segments=123,
            retries=123,
            retry_interval=123,
            scte35_source="scte35Source"
        ),
        server_validation="serverValidation"
    ),
    scte35_pid=123,
    smpte2038_data_preference="smpte2038DataPreference",
    source_end_behavior="sourceEndBehavior",
    video_selector=medialive.CfnChannel.VideoSelectorProperty(
        color_space="colorSpace",
        color_space_settings=medialive.CfnChannel.VideoSelectorColorSpaceSettingsProperty(
            hdr10_settings=medialive.CfnChannel.Hdr10SettingsProperty(
                max_cll=123,
                max_fall=123
            )
        ),
        color_space_usage="colorSpaceUsage",
        selector_settings=medialive.CfnChannel.VideoSelectorSettingsProperty(
            video_selector_pid=medialive.CfnChannel.VideoSelectorPidProperty(
                pid=123
            ),
            video_selector_program_id=medialive.CfnChannel.VideoSelectorProgramIdProperty(
                program_id=123
            )
        )
    )
)

Attributes

audio_selectors

Information about the specific audio to extract from the input.

The parent of this entity is InputSettings.

See:

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

caption_selectors

Information about the specific captions to extract from the input.

See:

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

deblock_filter

Enables or disables the deblock filter when filtering.

See:

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

denoise_filter

Enables or disables the denoise filter when filtering.

See:

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

filter_strength

Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).

See:

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

input_filter

Turns on the filter for this input.

MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering is applied depending on input type/quality 2) disabled - no filtering is applied to the input 3) forced - filtering is applied regardless of the input type.

See:

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

network_input_settings

Information about how to connect to the upstream system.

See:

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

scte35_pid

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

Type:

see

smpte2038_data_preference

Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input.

Applicable data types are captions, timecode, AFD, and SCTE-104 messages.

  • PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any).

  • IGNORE: Never extract any ancillary data from SMPTE-2038.

See:

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

source_end_behavior

The loop input if it is a file.

See:

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

video_selector

Information about one video to extract from the input.

See:

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

InputSpecificationProperty

class CfnChannel.InputSpecificationProperty(*, codec=None, maximum_bitrate=None, resolution=None)

Bases: object

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.

This entity is at the top level in the channel.

Parameters:
  • codec (Optional[str]) – The codec to include in the input specification for this channel.

  • maximum_bitrate (Optional[str]) – The maximum input bitrate for any input attached to this channel.

  • resolution (Optional[str]) – The resolution for any input attached to this channel.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputspecification.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

input_specification_property = medialive.CfnChannel.InputSpecificationProperty(
    codec="codec",
    maximum_bitrate="maximumBitrate",
    resolution="resolution"
)

Attributes

codec

The codec to include in the input specification for this channel.

See:

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

maximum_bitrate

The maximum input bitrate for any input attached to this channel.

See:

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

resolution

The resolution for any input attached to this channel.

See:

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

KeyProviderSettingsProperty

class CfnChannel.KeyProviderSettingsProperty(*, static_key_settings=None)

Bases: object

The configuration of key provider settings.

The parent of this entity is HlsGroupSettings.

Parameters:

static_key_settings (Union[IResolvable, StaticKeySettingsProperty, Dict[str, Any], None]) – The configuration of static key settings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-keyprovidersettings.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

key_provider_settings_property = medialive.CfnChannel.KeyProviderSettingsProperty(
    static_key_settings=medialive.CfnChannel.StaticKeySettingsProperty(
        key_provider_server=medialive.CfnChannel.InputLocationProperty(
            password_param="passwordParam",
            uri="uri",
            username="username"
        ),
        static_key_value="staticKeyValue"
    )
)

Attributes

static_key_settings

The configuration of static key settings.

See:

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

M2tsSettingsProperty

class CfnChannel.M2tsSettingsProperty(*, absent_input_audio_behavior=None, arib=None, arib_captions_pid=None, arib_captions_pid_control=None, audio_buffer_model=None, audio_frames_per_pes=None, audio_pids=None, audio_stream_type=None, bitrate=None, buffer_model=None, cc_descriptor=None, dvb_nit_settings=None, dvb_sdt_settings=None, dvb_sub_pids=None, dvb_tdt_settings=None, dvb_teletext_pid=None, ebif=None, ebp_audio_interval=None, ebp_lookahead_ms=None, ebp_placement=None, ecm_pid=None, es_rate_in_pes=None, etv_platform_pid=None, etv_signal_pid=None, fragment_time=None, klv=None, klv_data_pids=None, nielsen_id3_behavior=None, null_packet_bitrate=None, pat_interval=None, pcr_control=None, pcr_period=None, pcr_pid=None, pmt_interval=None, pmt_pid=None, program_num=None, rate_mode=None, scte27_pids=None, scte35_control=None, scte35_pid=None, scte35_preroll_pullup_milliseconds=None, segmentation_markers=None, segmentation_style=None, segmentation_time=None, timed_metadata_behavior=None, timed_metadata_pid=None, transport_stream_id=None, video_pid=None)

Bases: object

The configuration of the M2TS in the output.

The parents of this entity are ArchiveContainerSettings and UdpContainerSettings.

Parameters:
  • absent_input_audio_behavior (Optional[str]) – When set to drop, the output audio streams are removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on the input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.

  • arib (Optional[str]) – When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.

  • arib_captions_pid (Optional[str]) – The PID for ARIB Captions in the transport stream. You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

  • arib_captions_pid_control (Optional[str]) – If set to auto, The PID number used for ARIB Captions will be auto-selected from unused PIDs. If set to useConfigured, ARIB captions will be on the configured PID number.

  • audio_buffer_model (Optional[str]) – When set to dvb, uses the DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.

  • audio_frames_per_pes (Union[int, float, None]) – The number of audio frames to insert for each PES packet.

  • audio_pids (Optional[str]) – The PID of the elementary audio streams in the transport stream. Multiple values are accepted, and can be entered in ranges or by comma separation. You can enter the value as a decimal or hexadecimal value. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).

  • audio_stream_type (Optional[str]) – When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.

  • bitrate (Union[int, float, None]) – The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.

  • buffer_model (Optional[str]) – If set to multiplex, uses the multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices might not be able to play back the stream without interruptions.

  • cc_descriptor (Optional[str]) – When set to enabled, generates captionServiceDescriptor in PMT.

  • dvb_nit_settings (Union[IResolvable, DvbNitSettingsProperty, Dict[str, Any], None]) – Inserts a DVB Network Information Table (NIT) at the specified table repetition interval.

  • dvb_sdt_settings (Union[IResolvable, DvbSdtSettingsProperty, Dict[str, Any], None]) – Inserts a DVB Service Description Table (SDT) at the specified table repetition interval.

  • dvb_sub_pids (Optional[str]) – The PID for the input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. You can enter the value as a decimal or hexadecimal value. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).

  • dvb_tdt_settings (Union[IResolvable, DvbTdtSettingsProperty, Dict[str, Any], None]) – Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.

  • dvb_teletext_pid (Optional[str]) – The PID for the input source DVB Teletext data to this output. You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

  • ebif (Optional[str]) – If set to passthrough, passes any EBIF data from the input source to this output.

  • ebp_audio_interval (Optional[str]) – When videoAndFixedIntervals is selected, audio EBP markers are added to partitions 3 and 4. The interval between these additional markers is fixed, and is slightly shorter than the video EBP marker interval. This is only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 always follow the video interval.

  • ebp_lookahead_ms (Union[int, float, None]) – When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is “stretched” to the next marker. The lookahead value does not add latency to the system. The channel must be configured elsewhere to create sufficient latency to make the lookahead accurate.

  • ebp_placement (Optional[str]) – Controls placement of EBP on audio PIDs. If set to videoAndAudioPids, EBP markers are placed on the video PID and all audio PIDs. If set to videoPid, EBP markers are placed on only the video PID.

  • ecm_pid (Optional[str]) – This field is unused and deprecated.

  • es_rate_in_pes (Optional[str]) – Includes or excludes the ES Rate field in the PES header.

  • etv_platform_pid (Optional[str]) – The PID for the input source ETV Platform data to this output. You can enter it as a decimal or hexadecimal value. Valid values are 32 (or 0x20) to 8182 (or 0x1ff6).

  • etv_signal_pid (Optional[str]) – The PID for input source ETV Signal data to this output. You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

  • fragment_time (Union[int, float, None]) – The length in seconds of each fragment. This is used only with EBP markers.

  • klv (Optional[str]) – If set to passthrough, passes any KLV data from the input source to this output.

  • klv_data_pids (Optional[str]) – The PID for the input source KLV data to this output. Multiple values are accepted, and can be entered in ranges or by comma separation. You can enter the value as a decimal or hexadecimal value. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).

  • 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.

  • null_packet_bitrate (Union[int, float, None]) – The value, in bits per second, of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.

  • pat_interval (Union[int, float, None]) – The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.

  • pcr_control (Optional[str]) – When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.

  • pcr_period (Union[int, float, None]) – The maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream.

  • pcr_pid (Optional[str]) – The PID of the Program Clock Reference (PCR) in the transport stream. When no value is given, MediaLive assigns the same value as the video PID. You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

  • pmt_interval (Union[int, float, None]) – The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.

  • pmt_pid (Optional[str]) – The PID for the Program Map Table (PMT) in the transport stream. You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

  • program_num (Union[int, float, None]) – The value of the program number field in the Program Map Table (PMT).

  • rate_mode (Optional[str]) – When VBR, does not insert null packets into the transport stream to fill the specified bitrate. The bitrate setting acts as the maximum bitrate when VBR is set.

  • scte27_pids (Optional[str]) – The PID for the input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges or by comma separation. You can enter the value as a decimal or hexadecimal value. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).

  • scte35_control (Optional[str]) – Optionally passes SCTE-35 signals from the input source to this output.

  • scte35_pid (Optional[str]) – The PID of the SCTE-35 stream in the transport stream. You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

  • scte35_preroll_pullup_milliseconds (Union[int, float, None]) –

  • segmentation_markers (Optional[str]) – Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.

  • segmentation_style (Optional[str]) – The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments might be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of resetCadence is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of maintainCadence is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.

  • segmentation_time (Union[int, float, None]) – The length, in seconds, of each segment. This is required unless markers is set to None_.

  • timed_metadata_behavior (Optional[str]) – When set to passthrough, timed metadata is passed through from input to output.

  • timed_metadata_pid (Optional[str]) – The PID of the timed metadata stream in the transport stream. You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

  • transport_stream_id (Union[int, float, None]) – The value of the transport stream ID field in the Program Map Table (PMT).

  • video_pid (Optional[str]) – The PID of the elementary video stream in the transport stream. You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.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

m2ts_settings_property = 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"
)

Attributes

absent_input_audio_behavior

When set to drop, the output audio streams are removed from the program if the selected input audio stream is removed from the input.

This allows the output audio configuration to dynamically change based on the input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.

See:

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

arib

When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.

See:

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

arib_captions_pid

The PID for ARIB Captions in the transport stream.

You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

See:

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

arib_captions_pid_control

If set to auto, The PID number used for ARIB Captions will be auto-selected from unused PIDs.

If set to useConfigured, ARIB captions will be on the configured PID number.

See:

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

audio_buffer_model

When set to dvb, uses the DVB buffer model for Dolby Digital audio.

When set to atsc, the ATSC model is used.

See:

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

audio_frames_per_pes

The number of audio frames to insert for each PES packet.

See:

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

audio_pids

The PID of the elementary audio streams in the transport stream.

Multiple values are accepted, and can be entered in ranges or by comma separation. You can enter the value as a decimal or hexadecimal value. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).

See:

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

audio_stream_type

When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3.

When set to dvb, uses stream type = 0x06.

See:

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

bitrate

The output bitrate of the transport stream in bits per second.

Setting to 0 lets the muxer automatically determine the appropriate bitrate.

See:

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

buffer_model

If set to multiplex, uses the multiplex buffer model for accurate interleaving.

Setting to bufferModel to none can lead to lower latency, but low-memory devices might not be able to play back the stream without interruptions.

See:

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

cc_descriptor

When set to enabled, generates captionServiceDescriptor in PMT.

See:

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

dvb_nit_settings

Inserts a DVB Network Information Table (NIT) at the specified table repetition interval.

See:

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

dvb_sdt_settings

Inserts a DVB Service Description Table (SDT) at the specified table repetition interval.

See:

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

dvb_sub_pids

The PID for the input source DVB Subtitle data to this output.

Multiple values are accepted, and can be entered in ranges and/or by comma separation. You can enter the value as a decimal or hexadecimal value. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).

See:

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

dvb_tdt_settings

Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.

See:

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

dvb_teletext_pid

The PID for the input source DVB Teletext data to this output.

You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

See:

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

ebif

If set to passthrough, passes any EBIF data from the input source to this output.

See:

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

ebp_audio_interval

When videoAndFixedIntervals is selected, audio EBP markers are added to partitions 3 and 4.

The interval between these additional markers is fixed, and is slightly shorter than the video EBP marker interval. This is only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 always follow the video interval.

See:

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

ebp_lookahead_ms

When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video.

If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is “stretched” to the next marker. The lookahead value does not add latency to the system. The channel must be configured elsewhere to create sufficient latency to make the lookahead accurate.

See:

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

ebp_placement

Controls placement of EBP on audio PIDs.

If set to videoAndAudioPids, EBP markers are placed on the video PID and all audio PIDs. If set to videoPid, EBP markers are placed on only the video PID.

See:

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

ecm_pid

This field is unused and deprecated.

See:

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

es_rate_in_pes

Includes or excludes the ES Rate field in the PES header.

See:

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

etv_platform_pid

The PID for the input source ETV Platform data to this output.

You can enter it as a decimal or hexadecimal value. Valid values are 32 (or 0x20) to 8182 (or 0x1ff6).

See:

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

etv_signal_pid

The PID for input source ETV Signal data to this output.

You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

See:

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

fragment_time

The length in seconds of each fragment.

This is used only with EBP markers.

See:

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

klv

If set to passthrough, passes any KLV data from the input source to this output.

See:

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

klv_data_pids

The PID for the input source KLV data to this output.

Multiple values are accepted, and can be entered in ranges or by comma separation. You can enter the value as a decimal or hexadecimal value. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).

See:

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

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-m2tssettings.html#cfn-medialive-channel-m2tssettings-nielsenid3behavior

null_packet_bitrate

The value, in bits per second, of extra null packets to insert into the transport stream.

This can be used if a downstream encryption system requires periodic null packets.

See:

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

pat_interval

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

Valid values are 0, 10..1000.

See:

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

pcr_control

When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header.

This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.

See:

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

pcr_period

The maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream.

See:

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

pcr_pid

The PID of the Program Clock Reference (PCR) in the transport stream.

When no value is given, MediaLive assigns the same value as the video PID. You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

See:

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

pmt_interval

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

Valid values are 0, 10..1000.

See:

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

pmt_pid

The PID for the Program Map Table (PMT) in the transport stream.

You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

See:

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

program_num

The value of the program number field in the Program Map Table (PMT).

See:

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

rate_mode

When VBR, does not insert null packets into the transport stream to fill the specified bitrate.

The bitrate setting acts as the maximum bitrate when VBR is set.

See:

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

scte27_pids

The PID for the input source SCTE-27 data to this output.

Multiple values are accepted, and can be entered in ranges or by comma separation. You can enter the value as a decimal or hexadecimal value. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).

See:

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

scte35_control

Optionally passes SCTE-35 signals from the input source to this output.

See:

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

scte35_pid

The PID of the SCTE-35 stream in the transport stream.

You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

See:

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

scte35_preroll_pullup_milliseconds

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

Type:

see

segmentation_markers

Inserts segmentation markers at each segmentationTime period.

raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.

See:

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

segmentation_style

The segmentation style parameter controls how segmentation markers are inserted into the transport stream.

With avails, it is possible that segments might be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of resetCadence is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of maintainCadence is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.

See:

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

segmentation_time

The length, in seconds, of each segment.

This is required unless markers is set to None_.

See:

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

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-m2tssettings.html#cfn-medialive-channel-m2tssettings-timedmetadatabehavior

timed_metadata_pid

The PID of the timed metadata stream in the transport stream.

You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

See:

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

transport_stream_id

The value of the transport stream ID field in the Program Map Table (PMT).

See:

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

video_pid

The PID of the elementary video stream in the transport stream.

You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

See:

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

M3u8SettingsProperty

class CfnChannel.M3u8SettingsProperty(*, audio_frames_per_pes=None, audio_pids=None, ecm_pid=None, klv_behavior=None, klv_data_pids=None, nielsen_id3_behavior=None, pat_interval=None, pcr_control=None, pcr_period=None, pcr_pid=None, pmt_interval=None, pmt_pid=None, program_num=None, scte35_behavior=None, scte35_pid=None, timed_metadata_behavior=None, timed_metadata_pid=None, transport_stream_id=None, video_pid=None)

Bases: object

Settings for the M3U8 container.

The parent of this entity is StandardHlsSettings.

Parameters:
  • audio_frames_per_pes (Union[int, float, None]) – The number of audio frames to insert for each PES packet.

  • audio_pids (Optional[str]) – The PID of the elementary audio streams in the transport stream. Multiple values are accepted, and can be entered in ranges or by comma separation. You can enter the value as a decimal or hexadecimal value.

  • ecm_pid (Optional[str]) – This parameter is unused and deprecated.

  • klv_behavior (Optional[str]) –

  • klv_data_pids (Optional[str]) –

  • 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.

  • pat_interval (Union[int, float, None]) – The number of milliseconds between instances of this table in the output transport stream. A value of “0” writes out the PMT once per segment file.

  • pcr_control (Optional[str]) – When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.

  • pcr_period (Union[int, float, None]) – The maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream.

  • pcr_pid (Optional[str]) – The PID of the Program Clock Reference (PCR) in the transport stream. When no value is given, MediaLive assigns the same value as the video PID. You can enter the value as a decimal or hexadecimal value.

  • pmt_interval (Union[int, float, None]) – The number of milliseconds between instances of this table in the output transport stream. A value of “0” writes out the PMT once per segment file.

  • pmt_pid (Optional[str]) – The PID for the Program Map Table (PMT) in the transport stream. You can enter the value as a decimal or hexadecimal value.

  • program_num (Union[int, float, None]) – The value of the program number field in the Program Map Table (PMT).

  • scte35_behavior (Optional[str]) – If set to passthrough, passes any SCTE-35 signals from the input source to this output.

  • scte35_pid (Optional[str]) – The PID of the SCTE-35 stream in the transport stream. You can enter the value as a decimal or hexadecimal value.

  • timed_metadata_behavior (Optional[str]) – When set to passthrough, timed metadata is passed through from input to output.

  • timed_metadata_pid (Optional[str]) – The PID of the timed metadata stream in the transport stream. You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

  • transport_stream_id (Union[int, float, None]) – The value of the transport stream ID field in the Program Map Table (PMT).

  • video_pid (Optional[str]) – The PID of the elementary video stream in the transport stream. You can enter the value as a decimal or hexadecimal value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.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

m3u8_settings_property = medialive.CfnChannel.M3u8SettingsProperty(
    audio_frames_per_pes=123,
    audio_pids="audioPids",
    ecm_pid="ecmPid",
    klv_behavior="klvBehavior",
    klv_data_pids="klvDataPids",
    nielsen_id3_behavior="nielsenId3Behavior",
    pat_interval=123,
    pcr_control="pcrControl",
    pcr_period=123,
    pcr_pid="pcrPid",
    pmt_interval=123,
    pmt_pid="pmtPid",
    program_num=123,
    scte35_behavior="scte35Behavior",
    scte35_pid="scte35Pid",
    timed_metadata_behavior="timedMetadataBehavior",
    timed_metadata_pid="timedMetadataPid",
    transport_stream_id=123,
    video_pid="videoPid"
)

Attributes

audio_frames_per_pes

The number of audio frames to insert for each PES packet.

See:

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

audio_pids

The PID of the elementary audio streams in the transport stream.

Multiple values are accepted, and can be entered in ranges or by comma separation. You can enter the value as a decimal or hexadecimal value.

See:

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

ecm_pid

This parameter is unused and deprecated.

See:

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

klv_behavior

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

Type:

see

klv_data_pids

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

Type:

see

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-m3u8settings.html#cfn-medialive-channel-m3u8settings-nielsenid3behavior

pat_interval

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

A value of “0” writes out the PMT once per segment file.

See:

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

pcr_control

When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header.

This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.

See:

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

pcr_period

The maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream.

See:

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

pcr_pid

The PID of the Program Clock Reference (PCR) in the transport stream.

When no value is given, MediaLive assigns the same value as the video PID. You can enter the value as a decimal or hexadecimal value.

See:

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

pmt_interval

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

A value of “0” writes out the PMT once per segment file.

See:

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

pmt_pid

The PID for the Program Map Table (PMT) in the transport stream.

You can enter the value as a decimal or hexadecimal value.

See:

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

program_num

The value of the program number field in the Program Map Table (PMT).

See:

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

scte35_behavior

If set to passthrough, passes any SCTE-35 signals from the input source to this output.

See:

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

scte35_pid

The PID of the SCTE-35 stream in the transport stream.

You can enter the value as a decimal or hexadecimal value.

See:

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

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-m3u8settings.html#cfn-medialive-channel-m3u8settings-timedmetadatabehavior

timed_metadata_pid

The PID of the timed metadata stream in the transport stream.

You can enter the value as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

See:

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

transport_stream_id

The value of the transport stream ID field in the Program Map Table (PMT).

See:

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

video_pid

The PID of the elementary video stream in the transport stream.

You can enter the value as a decimal or hexadecimal value.

See:

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

MaintenanceCreateSettingsProperty

class CfnChannel.MaintenanceCreateSettingsProperty(*, maintenance_day=None, maintenance_start_time=None)

Bases: object

Parameters:
  • maintenance_day (Optional[str]) – Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows.

  • maintenance_start_time (Optional[str]) – Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-maintenancecreatesettings.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

maintenance_create_settings_property = medialive.CfnChannel.MaintenanceCreateSettingsProperty(
    maintenance_day="maintenanceDay",
    maintenance_start_time="maintenanceStartTime"
)

Attributes

maintenance_day

Choose one day of the week for maintenance.

The chosen day is used for all future maintenance windows.

See:

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

maintenance_start_time

Choose the hour that maintenance will start.

The chosen time is used for all future maintenance windows.

See:

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

MaintenanceUpdateSettingsProperty

class CfnChannel.MaintenanceUpdateSettingsProperty(*, maintenance_day=None, maintenance_scheduled_date=None, maintenance_start_time=None)

Bases: object

Parameters:
  • maintenance_day (Optional[str]) –

  • maintenance_scheduled_date (Optional[str]) –

  • maintenance_start_time (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-maintenanceupdatesettings.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

maintenance_update_settings_property = medialive.CfnChannel.MaintenanceUpdateSettingsProperty(
    maintenance_day="maintenanceDay",
    maintenance_scheduled_date="maintenanceScheduledDate",
    maintenance_start_time="maintenanceStartTime"
)

Attributes

maintenance_day

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

Type:

see

maintenance_scheduled_date

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

Type:

see

maintenance_start_time

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

Type:

see

MediaPackageGroupSettingsProperty

class CfnChannel.MediaPackageGroupSettingsProperty(*, destination=None)

Bases: object

The settings for the MediaPackage group.

The parent of this entity is OutputGroupSettings.

Parameters:

destination (Union[IResolvable, OutputLocationRefProperty, Dict[str, Any], None]) – The MediaPackage channel destination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagegroupsettings.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

media_package_group_settings_property = medialive.CfnChannel.MediaPackageGroupSettingsProperty(
    destination=medialive.CfnChannel.OutputLocationRefProperty(
        destination_ref_id="destinationRefId"
    )
)

Attributes

destination

The MediaPackage channel destination.

See:

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

MediaPackageOutputDestinationSettingsProperty

class CfnChannel.MediaPackageOutputDestinationSettingsProperty(*, channel_id=None)

Bases: object

Destination settings for a MediaPackage output.

The parent of this entity is OutputDestination.

Parameters:

channel_id (Optional[str]) – The ID of the channel in MediaPackage that is the destination for this output group. You don’t need to specify the individual inputs in MediaPackage; MediaLive handles the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same Region.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackageoutputdestinationsettings.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

media_package_output_destination_settings_property = medialive.CfnChannel.MediaPackageOutputDestinationSettingsProperty(
    channel_id="channelId"
)

Attributes

channel_id

The ID of the channel in MediaPackage that is the destination for this output group.

You don’t need to specify the individual inputs in MediaPackage; MediaLive handles the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same Region.

See:

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

MediaPackageOutputSettingsProperty

class CfnChannel.MediaPackageOutputSettingsProperty

Bases: object

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackageoutputsettings.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

media_package_output_settings_property = medialive.CfnChannel.MediaPackageOutputSettingsProperty()

MotionGraphicsConfigurationProperty

class CfnChannel.MotionGraphicsConfigurationProperty(*, motion_graphics_insertion=None, motion_graphics_settings=None)

Bases: object

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

The parent of this entity is EncoderSettings.

Parameters:
  • motion_graphics_insertion (Optional[str]) – Enables or disables the motion graphics overlay feature in the channel.

  • motion_graphics_settings (Union[IResolvable, MotionGraphicsSettingsProperty, Dict[str, Any], None]) – 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-motiongraphicsconfiguration.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

motion_graphics_configuration_property = medialive.CfnChannel.MotionGraphicsConfigurationProperty(
    motion_graphics_insertion="motionGraphicsInsertion",
    motion_graphics_settings=medialive.CfnChannel.MotionGraphicsSettingsProperty(
        html_motion_graphics_settings=medialive.CfnChannel.HtmlMotionGraphicsSettingsProperty()
    )
)

Attributes

motion_graphics_insertion

Enables or disables the motion graphics overlay feature in the channel.

See:

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

motion_graphics_settings

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-motiongraphicsconfiguration.html#cfn-medialive-channel-motiongraphicsconfiguration-motiongraphicssettings

MotionGraphicsSettingsProperty

class CfnChannel.MotionGraphicsSettingsProperty(*, html_motion_graphics_settings=None)

Bases: object

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

The parent of this entity is MotionGraphicsConfiguration.

Parameters:

html_motion_graphics_settings (Union[IResolvable, HtmlMotionGraphicsSettingsProperty, Dict[str, Any], None]) – Settings to configure the motion graphics overlay to use an HTML asset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-motiongraphicssettings.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

motion_graphics_settings_property = medialive.CfnChannel.MotionGraphicsSettingsProperty(
    html_motion_graphics_settings=medialive.CfnChannel.HtmlMotionGraphicsSettingsProperty()
)

Attributes

html_motion_graphics_settings

Settings to configure the motion graphics overlay to use an HTML asset.

See:

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

Mp2SettingsProperty

class CfnChannel.Mp2SettingsProperty(*, bitrate=None, coding_mode=None, sample_rate=None)

Bases: object

The configuration for this MP2 audio.

The parent of this entity is AudioCodecSettings.

Parameters:
  • bitrate (Union[int, float, None]) – The average bitrate in bits/second.

  • coding_mode (Optional[str]) – The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).

  • sample_rate (Union[int, float, None]) – The sample rate in Hz.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mp2settings.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

mp2_settings_property = medialive.CfnChannel.Mp2SettingsProperty(
    bitrate=123,
    coding_mode="codingMode",
    sample_rate=123
)

Attributes

bitrate

The average bitrate in bits/second.

See:

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

coding_mode

The MPEG2 Audio coding mode.

Valid values are codingMode10 (for mono) or codingMode20 (for stereo).

See:

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

sample_rate

The sample rate in Hz.

See:

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

Mpeg2FilterSettingsProperty

class CfnChannel.Mpeg2FilterSettingsProperty(*, temporal_filter_settings=None)

Bases: object

Settings to configure video filters that apply to the MPEG-2 codec.

The parent of this entity is Mpeg2FilterSettings.

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-mpeg2filtersettings.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

mpeg2_filter_settings_property = medialive.CfnChannel.Mpeg2FilterSettingsProperty(
    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-mpeg2filtersettings.html#cfn-medialive-channel-mpeg2filtersettings-temporalfiltersettings

Mpeg2SettingsProperty

class CfnChannel.Mpeg2SettingsProperty(*, adaptive_quantization=None, afd_signaling=None, color_metadata=None, color_space=None, display_aspect_ratio=None, filter_settings=None, fixed_afd=None, framerate_denominator=None, framerate_numerator=None, gop_closed_cadence=None, gop_num_b_frames=None, gop_size=None, gop_size_units=None, scan_type=None, subgop_length=None, timecode_burnin_settings=None, timecode_insertion=None)

Bases: object

The settings for the MPEG-2 codec in the output.

The parent of this entity is VideoCodecSetting.

Parameters:
  • adaptive_quantization (Optional[str]) – Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality.

  • afd_signaling (Optional[str]) – Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: MediaLive will use the value you specify in fixedAFD.

  • color_metadata (Optional[str]) – Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata.

  • color_space (Optional[str]) – Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on “MediaLive Features - Video - color space” in the MediaLive User Guide. PASSTHROUGH: Keep the color space of the input content - do not convert it. AUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709.

  • display_aspect_ratio (Optional[str]) – Sets the pixel aspect ratio for the encode.

  • filter_settings (Union[IResolvable, Mpeg2FilterSettingsProperty, Dict[str, Any], None]) – Optionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied. TEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean. When the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise. When the content is reasonably clean, the filter tends to decrease the bitrate.

  • fixed_afd (Optional[str]) – Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode.

  • framerate_denominator (Union[int, float, None]) – description”: “The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.

  • framerate_numerator (Union[int, float, None]) – The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.

  • gop_closed_cadence (Union[int, float, None]) – MPEG2: default is open GOP.

  • gop_num_b_frames (Union[int, float, None]) – Relates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default.

  • gop_size (Union[int, float, None]) – Relates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default. If gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer.

  • gop_size_units (Optional[str]) – Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count.

  • scan_type (Optional[str]) – Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).

  • subgop_length (Optional[str]) – Relates to the GOP structure. If you do not know what GOP is, use the default. FIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames. DYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality.

  • timecode_burnin_settings (Union[IResolvable, TimecodeBurninSettingsProperty, Dict[str, Any], None]) –

  • timecode_insertion (Optional[str]) – Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on “MediaLive Features - Timecode configuration” in the MediaLive User Guide. DISABLED: do not include timecodes. GOP_TIMECODE: Include timecode metadata in the GOP header.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.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

mpeg2_settings_property = medialive.CfnChannel.Mpeg2SettingsProperty(
    adaptive_quantization="adaptiveQuantization",
    afd_signaling="afdSignaling",
    color_metadata="colorMetadata",
    color_space="colorSpace",
    display_aspect_ratio="displayAspectRatio",
    filter_settings=medialive.CfnChannel.Mpeg2FilterSettingsProperty(
        temporal_filter_settings=medialive.CfnChannel.TemporalFilterSettingsProperty(
            post_filter_sharpening="postFilterSharpening",
            strength="strength"
        )
    ),
    fixed_afd="fixedAfd",
    framerate_denominator=123,
    framerate_numerator=123,
    gop_closed_cadence=123,
    gop_num_bFrames=123,
    gop_size=123,
    gop_size_units="gopSizeUnits",
    scan_type="scanType",
    subgop_length="subgopLength",
    timecode_burnin_settings=medialive.CfnChannel.TimecodeBurninSettingsProperty(
        font_size="fontSize",
        position="position",
        prefix="prefix"
    ),
    timecode_insertion="timecodeInsertion"
)

Attributes

adaptive_quantization

Choose Off to disable adaptive quantization.

Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality.

See:

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

afd_signaling

Indicates the AFD values that MediaLive will write into the video encode.

If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: MediaLive will use the value you specify in fixedAFD.

See:

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

color_metadata

Specifies whether to include the color space metadata.

The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata.

See:

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

color_space

Choose the type of color space conversion to apply to the output.

For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on “MediaLive Features - Video - color space” in the MediaLive User Guide. PASSTHROUGH: Keep the color space of the input content - do not convert it. AUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709.

See:

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

display_aspect_ratio

Sets the pixel aspect ratio for the encode.

See:

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

filter_settings

Optionally specify a noise reduction filter, which can improve quality of compressed content.

If you do not choose a filter, no filter will be applied. TEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean. When the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise. When the content is reasonably clean, the filter tends to decrease the bitrate.

See:

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

fixed_afd

Complete this field only when afdSignaling is set to FIXED.

Enter the AFD value (4 bits) to write on all frames of the video encode.

See:

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

framerate_denominator

“The framerate denominator.

For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.

See:

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

Type:

description”

framerate_numerator

The framerate numerator.

For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.

See:

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

gop_closed_cadence

default is open GOP.

See:

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

Type:

MPEG2

gop_num_b_frames

Relates to the GOP structure.

The number of B-frames between reference frames. If you do not know what a B-frame is, use the default.

See:

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

gop_size

Relates to the GOP structure.

The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default. If gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer.

See:

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

gop_size_units

Relates to the GOP structure.

Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count.

See:

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

scan_type

Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).

See:

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

subgop_length

Relates to the GOP structure.

If you do not know what GOP is, use the default. FIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames. DYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality.

See:

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

timecode_burnin_settings

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

Type:

see

timecode_insertion

Determines how MediaLive inserts timecodes in the output video.

For detailed information about setting up the input and the output for a timecode, see the section on “MediaLive Features - Timecode configuration” in the MediaLive User Guide. DISABLED: do not include timecodes. GOP_TIMECODE: Include timecode metadata in the GOP header.

See:

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

MsSmoothGroupSettingsProperty

class CfnChannel.MsSmoothGroupSettingsProperty(*, acquisition_point_id=None, audio_only_timecode_control=None, certificate_mode=None, connection_retry_interval=None, destination=None, event_id=None, event_id_mode=None, event_stop_behavior=None, filecache_duration=None, fragment_length=None, input_loss_action=None, num_retries=None, restart_delay=None, segmentation_mode=None, send_delay_ms=None, sparse_track_type=None, stream_manifest_behavior=None, timestamp_offset=None, timestamp_offset_mode=None)

Bases: object

The settings for a Microsoft Smooth output group.

The parent of this entity is OutputGroupSettings.

Parameters:
  • acquisition_point_id (Optional[str]) – The value of the Acquisition Point Identity element that is used in each message placed in the sparse track. Enabled only if sparseTrackType is not “none.”

  • audio_only_timecode_control (Optional[str]) – If set to passthrough for an audio-only Microsoft Smooth output, the fragment absolute time is set to the current timecode. This option does not write timecodes to the audio elementary stream.

  • certificate_mode (Optional[str]) – If set to verifyAuthenticity, verifies the HTTPS certificate chain to a trusted certificate authority (CA). This causes HTTPS outputs to self-signed certificates to fail.

  • connection_retry_interval (Union[int, float, None]) – The number of seconds to wait before retrying the connection to the IIS server if the connection is lost. Content is cached during this time, and the cache is delivered to the IIS server after the connection is re-established.

  • destination (Union[IResolvable, OutputLocationRefProperty, Dict[str, Any], None]) – The Smooth Streaming publish point on an IIS server. MediaLive acts as a “Push” encoder to IIS.

  • event_id (Optional[str]) – The Microsoft Smooth channel ID that is sent to the IIS server. Specify the ID only if eventIdMode is set to useConfigured.

  • event_id_mode (Optional[str]) – Specifies whether to send a channel ID to the IIS server. If no channel ID is sent and the same channel is used without changing the publishing point, clients might see cached video from the previous run. Options: - “useConfigured” - use the value provided in eventId - “useTimestamp” - generate and send a channel ID based on the current timestamp - “noEventId” - do not send a channel ID to the IIS server.

  • event_stop_behavior (Optional[str]) – When set to sendEos, sends an EOS signal to an IIS server when stopping the channel.

  • filecache_duration (Union[int, float, None]) – The size, in seconds, of the file cache for streaming outputs.

  • fragment_length (Union[int, float, None]) – The length, in seconds, of mp4 fragments to generate. The fragment length must be compatible with GOP size and frame rate.

  • input_loss_action (Optional[str]) – A parameter that controls output group behavior on an input loss.

  • num_retries (Union[int, float, None]) – The number of retry attempts.

  • restart_delay (Union[int, float, None]) – The number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.

  • segmentation_mode (Optional[str]) – useInputSegmentation has been deprecated. The configured segment size is always used.

  • send_delay_ms (Union[int, float, None]) – The number of milliseconds to delay the output from the second pipeline.

  • sparse_track_type (Optional[str]) – If set to scte35, uses incoming SCTE-35 messages to generate a sparse track in this group of Microsoft Smooth outputs.

  • stream_manifest_behavior (Optional[str]) – When set to send, sends a stream manifest so that the publishing point doesn’t start until all streams start.

  • timestamp_offset (Optional[str]) – The timestamp offset for the channel. Used only if timestampOffsetMode is set to useConfiguredOffset.

  • timestamp_offset_mode (Optional[str]) – The type of timestamp date offset to use. - useEventStartDate: Use the date the channel was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.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

ms_smooth_group_settings_property = medialive.CfnChannel.MsSmoothGroupSettingsProperty(
    acquisition_point_id="acquisitionPointId",
    audio_only_timecode_control="audioOnlyTimecodeControl",
    certificate_mode="certificateMode",
    connection_retry_interval=123,
    destination=medialive.CfnChannel.OutputLocationRefProperty(
        destination_ref_id="destinationRefId"
    ),
    event_id="eventId",
    event_id_mode="eventIdMode",
    event_stop_behavior="eventStopBehavior",
    filecache_duration=123,
    fragment_length=123,
    input_loss_action="inputLossAction",
    num_retries=123,
    restart_delay=123,
    segmentation_mode="segmentationMode",
    send_delay_ms=123,
    sparse_track_type="sparseTrackType",
    stream_manifest_behavior="streamManifestBehavior",
    timestamp_offset="timestampOffset",
    timestamp_offset_mode="timestampOffsetMode"
)

Attributes

acquisition_point_id

The value of the Acquisition Point Identity element that is used in each message placed in the sparse track.

Enabled only if sparseTrackType is not “none.”

See:

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

audio_only_timecode_control

If set to passthrough for an audio-only Microsoft Smooth output, the fragment absolute time is set to the current timecode.

This option does not write timecodes to the audio elementary stream.

See:

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

certificate_mode

If set to verifyAuthenticity, verifies the HTTPS certificate chain to a trusted certificate authority (CA).

This causes HTTPS outputs to self-signed certificates to fail.

See:

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

connection_retry_interval

The number of seconds to wait before retrying the connection to the IIS server if the connection is lost.

Content is cached during this time, and the cache is delivered to the IIS server after the connection is re-established.

See:

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

destination

The Smooth Streaming publish point on an IIS server.

MediaLive acts as a “Push” encoder to IIS.

See:

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

event_id

The Microsoft Smooth channel ID that is sent to the IIS server.

Specify the ID only if eventIdMode is set to useConfigured.

See:

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

event_id_mode

Specifies whether to send a channel ID to the IIS server.

If no channel ID is sent and the same channel is used without changing the publishing point, clients might see cached video from the previous run. Options: - “useConfigured” - use the value provided in eventId - “useTimestamp” - generate and send a channel ID based on the current timestamp - “noEventId” - do not send a channel ID to the IIS server.

See:

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

event_stop_behavior

When set to sendEos, sends an EOS signal to an IIS server when stopping the channel.

See:

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

filecache_duration

The size, in seconds, of the file cache for streaming outputs.

See:

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

fragment_length

The length, in seconds, of mp4 fragments to generate.

The fragment length must be compatible with GOP size and frame rate.

See:

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

input_loss_action

A parameter that controls output group behavior on an input loss.

See:

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

num_retries

The number of retry attempts.

See:

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

restart_delay

The number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.

See:

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

segmentation_mode

useInputSegmentation has been deprecated.

The configured segment size is always used.

See:

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

send_delay_ms

The number of milliseconds to delay the output from the second pipeline.

See:

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

sparse_track_type

If set to scte35, uses incoming SCTE-35 messages to generate a sparse track in this group of Microsoft Smooth outputs.

See:

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

stream_manifest_behavior

When set to send, sends a stream manifest so that the publishing point doesn’t start until all streams start.

See:

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

timestamp_offset

The timestamp offset for the channel.

Used only if timestampOffsetMode is set to useConfiguredOffset.

See:

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

timestamp_offset_mode

The type of timestamp date offset to use.

  • useEventStartDate: Use the date the channel was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset.

See:

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

MsSmoothOutputSettingsProperty

class CfnChannel.MsSmoothOutputSettingsProperty(*, h265_packaging_type=None, name_modifier=None)

Bases: object

Configuration of a Microsoft Smooth output.

The parent of this entity is OutputSettings.

Parameters:
  • h265_packaging_type (Optional[str]) – Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.

  • name_modifier (Optional[str]) – A string that is concatenated to the end of the destination file name. This is required for multiple outputs of the same type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothoutputsettings.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

ms_smooth_output_settings_property = medialive.CfnChannel.MsSmoothOutputSettingsProperty(
    h265_packaging_type="h265PackagingType",
    name_modifier="nameModifier"
)

Attributes

h265_packaging_type

Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.

See:

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

name_modifier

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

This is required for multiple outputs of the same type.

See:

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

MultiplexGroupSettingsProperty

class CfnChannel.MultiplexGroupSettingsProperty

Bases: object

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexgroupsettings.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

multiplex_group_settings_property = medialive.CfnChannel.MultiplexGroupSettingsProperty()

MultiplexOutputSettingsProperty

class CfnChannel.MultiplexOutputSettingsProperty(*, destination=None)

Bases: object

Configuration of a Multiplex output.

The parent of this entity is OutputSettings.

Parameters:

destination (Union[IResolvable, OutputLocationRefProperty, Dict[str, Any], None]) – Destination is a Multiplex.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexoutputsettings.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

multiplex_output_settings_property = medialive.CfnChannel.MultiplexOutputSettingsProperty(
    destination=medialive.CfnChannel.OutputLocationRefProperty(
        destination_ref_id="destinationRefId"
    )
)

Attributes

destination

Destination is a Multiplex.

See:

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

MultiplexProgramChannelDestinationSettingsProperty

class CfnChannel.MultiplexProgramChannelDestinationSettingsProperty(*, multiplex_id=None, program_name=None)

Bases: object

Destination settings for a Multiplex output.

The parent of this entity is OutputDestination.

Parameters:
  • multiplex_id (Optional[str]) – The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel.

  • program_name (Optional[str]) – The program name of the Multiplex program that the encoder is providing output to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexprogramchanneldestinationsettings.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

multiplex_program_channel_destination_settings_property = medialive.CfnChannel.MultiplexProgramChannelDestinationSettingsProperty(
    multiplex_id="multiplexId",
    program_name="programName"
)

Attributes

multiplex_id

The ID of the Multiplex that the encoder is providing output to.

You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel.

See:

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

program_name

The program name of the Multiplex program that the encoder is providing output to.

See:

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

NetworkInputSettingsProperty

class CfnChannel.NetworkInputSettingsProperty(*, hls_input_settings=None, server_validation=None)

Bases: object

Information about how to connect to the upstream system.

The parent of this entity is InputSettings.

Parameters:
  • hls_input_settings (Union[IResolvable, HlsInputSettingsProperty, Dict[str, Any], None]) – Information about how to connect to the upstream system.

  • server_validation (Optional[str]) – Checks HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate is checked, but not the server’s name. Certain subdomains (notably S3 buckets that use dots in the bucket name) don’t strictly match the corresponding certificate’s wildcard pattern and would otherwise cause the channel to error. This setting is ignored for protocols that do not use HTTPS.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-networkinputsettings.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

network_input_settings_property = medialive.CfnChannel.NetworkInputSettingsProperty(
    hls_input_settings=medialive.CfnChannel.HlsInputSettingsProperty(
        bandwidth=123,
        buffer_segments=123,
        retries=123,
        retry_interval=123,
        scte35_source="scte35Source"
    ),
    server_validation="serverValidation"
)

Attributes

hls_input_settings

Information about how to connect to the upstream system.

See:

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

server_validation

Checks HTTPS server certificates.

When set to checkCryptographyOnly, cryptography in the certificate is checked, but not the server’s name. Certain subdomains (notably S3 buckets that use dots in the bucket name) don’t strictly match the corresponding certificate’s wildcard pattern and would otherwise cause the channel to error. This setting is ignored for protocols that do not use HTTPS.

See:

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

NielsenCBETProperty

class CfnChannel.NielsenCBETProperty(*, cbet_check_digit_string=None, cbet_stepaside=None, csid=None)

Bases: object

Complete these fields only if you want to insert watermarks of type Nielsen CBET.

The parent of this entity is NielsenWatermarksSettings

Parameters:
  • cbet_check_digit_string (Optional[str]) – Enter the CBET check digits to use in the watermark.

  • cbet_stepaside (Optional[str]) – Determines the method of CBET insertion mode when prior encoding is detected on the same layer.

  • csid (Optional[str]) – Enter the CBET Source ID (CSID) to use in the watermark.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsencbet.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

nielsen_cBETProperty = medialive.CfnChannel.NielsenCBETProperty(
    cbet_check_digit_string="cbetCheckDigitString",
    cbet_stepaside="cbetStepaside",
    csid="csid"
)

Attributes

cbet_check_digit_string

Enter the CBET check digits to use in the watermark.

See:

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

cbet_stepaside

Determines the method of CBET insertion mode when prior encoding is detected on the same layer.

See:

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

csid

Enter the CBET Source ID (CSID) to use in the watermark.

See:

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

NielsenConfigurationProperty

class CfnChannel.NielsenConfigurationProperty(*, distributor_id=None, nielsen_pcm_to_id3_tagging=None)

Bases: object

The settings to configure Nielsen watermarks.

The parent of this entity is EncoderSettings.

Parameters:
  • distributor_id (Optional[str]) – Enter the Distributor ID assigned to your organization by Nielsen.

  • nielsen_pcm_to_id3_tagging (Optional[str]) – Enables Nielsen PCM to ID3 tagging.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsenconfiguration.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

nielsen_configuration_property = medialive.CfnChannel.NielsenConfigurationProperty(
    distributor_id="distributorId",
    nielsen_pcm_to_id3_tagging="nielsenPcmToId3Tagging"
)

Attributes

distributor_id

Enter the Distributor ID assigned to your organization by Nielsen.

See:

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

nielsen_pcm_to_id3_tagging

Enables Nielsen PCM to ID3 tagging.

See:

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

NielsenNaesIiNwProperty

class CfnChannel.NielsenNaesIiNwProperty(*, check_digit_string=None, sid=None, timezone=None)

Bases: object

Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW).

The parent of this entity is NielsenWatermarksSettings.

Parameters:
  • check_digit_string (Optional[str]) – Enter the check digit string for the watermark.

  • sid (Union[int, float, None]) – Enter the Nielsen Source ID (SID) to include in the watermark.

  • timezone (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsennaesiinw.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

nielsen_naes_ii_nw_property = medialive.CfnChannel.NielsenNaesIiNwProperty(
    check_digit_string="checkDigitString",
    sid=123,
    timezone="timezone"
)

Attributes

check_digit_string

Enter the check digit string for the watermark.

See:

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

sid

Enter the Nielsen Source ID (SID) to include in the watermark.

See:

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

timezone

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

Type:

see

NielsenWatermarksSettingsProperty

class CfnChannel.NielsenWatermarksSettingsProperty(*, nielsen_cbet_settings=None, nielsen_distribution_type=None, nielsen_naes_ii_nw_settings=None)

Bases: object

Settings to configure Nielsen Watermarks in the audio encode.

The parent of this entity is AudioWatermarkSettings.

Parameters:
  • nielsen_cbet_settings (Union[IResolvable, NielsenCBETProperty, Dict[str, Any], None]) – Complete these fields only if you want to insert watermarks of type Nielsen CBET.

  • nielsen_distribution_type (Optional[str]) – Choose the distribution types that you want to assign to the watermarks: - PROGRAM_CONTENT - FINAL_DISTRIBUTOR.

  • nielsen_naes_ii_nw_settings (Union[IResolvable, NielsenNaesIiNwProperty, Dict[str, Any], None]) – Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsenwatermarkssettings.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

nielsen_watermarks_settings_property = 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_cbet_settings

Complete these fields only if you want to insert watermarks of type Nielsen CBET.

See:

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

nielsen_distribution_type
  • PROGRAM_CONTENT - FINAL_DISTRIBUTOR.

See:

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

Type:

Choose the distribution types that you want to assign to the watermarks

nielsen_naes_ii_nw_settings

Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW).

See:

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

OutputDestinationProperty

class CfnChannel.OutputDestinationProperty(*, id=None, media_package_settings=None, multiplex_settings=None, settings=None)

Bases: object

Configuration information for an output.

This entity is at the top level in the channel.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestination.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

output_destination_property = medialive.CfnChannel.OutputDestinationProperty(
    id="id",
    media_package_settings=[medialive.CfnChannel.MediaPackageOutputDestinationSettingsProperty(
        channel_id="channelId"
    )],
    multiplex_settings=medialive.CfnChannel.MultiplexProgramChannelDestinationSettingsProperty(
        multiplex_id="multiplexId",
        program_name="programName"
    ),
    settings=[medialive.CfnChannel.OutputDestinationSettingsProperty(
        password_param="passwordParam",
        stream_name="streamName",
        url="url",
        username="username"
    )]
)

Attributes

id

The ID for this destination.

See:

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

media_package_settings

The destination settings for a MediaPackage output.

See:

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

multiplex_settings

Destination settings for a Multiplex output;

one destination for both encoders.

See:

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

settings

The destination settings for an output.

See:

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

OutputDestinationSettingsProperty

class CfnChannel.OutputDestinationSettingsProperty(*, password_param=None, stream_name=None, url=None, username=None)

Bases: object

The configuration information for this output.

The parent of this entity is OutputDestination.

Parameters:
  • password_param (Optional[str]) – The password parameter that holds the password for accessing the downstream system. This password parameter applies only if the downstream system requires credentials.

  • stream_name (Optional[str]) – The stream name for the content. This applies only to RTMP outputs.

  • url (Optional[str]) – The URL for the destination.

  • username (Optional[str]) – The user name to connect to the downstream system. This applies only if the downstream system requires credentials.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestinationsettings.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

output_destination_settings_property = medialive.CfnChannel.OutputDestinationSettingsProperty(
    password_param="passwordParam",
    stream_name="streamName",
    url="url",
    username="username"
)

Attributes

password_param

The password parameter that holds the password for accessing the downstream system.

This password parameter applies only if the downstream system requires credentials.

See:

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

stream_name

The stream name for the content.

This applies only to RTMP outputs.

See:

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

url

The URL for the destination.

See:

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

username

The user name to connect to the downstream system.

This applies only if the downstream system requires credentials.

See:

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

OutputGroupProperty

class CfnChannel.OutputGroupProperty(*, name=None, output_group_settings=None, outputs=None)

Bases: object

The settings for one output group.

The parent of this entity is EncoderSettings.

Parameters:
  • name (Optional[str]) – A custom output group name that you can optionally define. Only letters, numbers, and the underscore character are allowed. The maximum length is 32 characters.

  • output_group_settings (Union[IResolvable, OutputGroupSettingsProperty, Dict[str, Any], None]) – The settings associated with the output group.

  • outputs (Union[IResolvable, Sequence[Union[IResolvable, OutputProperty, Dict[str, Any]]], None]) – The settings for the outputs in the output group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroup.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

output_group_property = medialive.CfnChannel.OutputGroupProperty(
    name="name",
    output_group_settings=medialive.CfnChannel.OutputGroupSettingsProperty(
        archive_group_settings=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
        ),
        frame_capture_group_settings=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"
                )
            )
        ),
        hls_group_settings=medialive.CfnChannel.HlsGroupSettingsProperty(
            ad_markers=["adMarkers"],
            base_url_content="baseUrlContent",
            base_url_content1="baseUrlContent1",
            base_url_manifest="baseUrlManifest",
            base_url_manifest1="baseUrlManifest1",
            caption_language_mappings=[medialive.CfnChannel.CaptionLanguageMappingProperty(
                caption_channel=123,
                language_code="languageCode",
                language_description="languageDescription"
            )],
            caption_language_setting="captionLanguageSetting",
            client_cache="clientCache",
            codec_specification="codecSpecification",
            constant_iv="constantIv",
            destination=medialive.CfnChannel.OutputLocationRefProperty(
                destination_ref_id="destinationRefId"
            ),
            directory_structure="directoryStructure",
            discontinuity_tags="discontinuityTags",
            encryption_type="encryptionType",
            hls_cdn_settings=medialive.CfnChannel.HlsCdnSettingsProperty(
                hls_akamai_settings=medialive.CfnChannel.HlsAkamaiSettingsProperty(
                    connection_retry_interval=123,
                    filecache_duration=123,
                    http_transfer_mode="httpTransferMode",
                    num_retries=123,
                    restart_delay=123,
                    salt="salt",
                    token="token"
                ),
                hls_basic_put_settings=medialive.CfnChannel.HlsBasicPutSettingsProperty(
                    connection_retry_interval=123,
                    filecache_duration=123,
                    num_retries=123,
                    restart_delay=123
                ),
                hls_media_store_settings=medialive.CfnChannel.HlsMediaStoreSettingsProperty(
                    connection_retry_interval=123,
                    filecache_duration=123,
                    media_store_storage_class="mediaStoreStorageClass",
                    num_retries=123,
                    restart_delay=123
                ),
                hls_s3_settings=medialive.CfnChannel.HlsS3SettingsProperty(
                    canned_acl="cannedAcl"
                ),
                hls_webdav_settings=medialive.CfnChannel.HlsWebdavSettingsProperty(
                    connection_retry_interval=123,
                    filecache_duration=123,
                    http_transfer_mode="httpTransferMode",
                    num_retries=123,
                    restart_delay=123
                )
            ),
            hls_id3_segment_tagging="hlsId3SegmentTagging",
            i_frame_only_playlists="iFrameOnlyPlaylists",
            incomplete_segment_behavior="incompleteSegmentBehavior",
            index_nSegments=123,
            input_loss_action="inputLossAction",
            iv_in_manifest="ivInManifest",
            iv_source="ivSource",
            keep_segments=123,
            key_format="keyFormat",
            key_format_versions="keyFormatVersions",
            key_provider_settings=medialive.CfnChannel.KeyProviderSettingsProperty(
                static_key_settings=medialive.CfnChannel.StaticKeySettingsProperty(
                    key_provider_server=medialive.CfnChannel.InputLocationProperty(
                        password_param="passwordParam",
                        uri="uri",
                        username="username"
                    ),
                    static_key_value="staticKeyValue"
                )
            ),
            manifest_compression="manifestCompression",
            manifest_duration_format="manifestDurationFormat",
            min_segment_length=123,
            mode="mode",
            output_selection="outputSelection",
            program_date_time="programDateTime",
            program_date_time_clock="programDateTimeClock",
            program_date_time_period=123,
            redundant_manifest="redundantManifest",
            segmentation_mode="segmentationMode",
            segment_length=123,
            segments_per_subdirectory=123,
            stream_inf_resolution="streamInfResolution",
            timed_metadata_id3_frame="timedMetadataId3Frame",
            timed_metadata_id3_period=123,
            timestamp_delta_milliseconds=123,
            ts_file_mode="tsFileMode"
        ),
        media_package_group_settings=medialive.CfnChannel.MediaPackageGroupSettingsProperty(
            destination=medialive.CfnChannel.OutputLocationRefProperty(
                destination_ref_id="destinationRefId"
            )
        ),
        ms_smooth_group_settings=medialive.CfnChannel.MsSmoothGroupSettingsProperty(
            acquisition_point_id="acquisitionPointId",
            audio_only_timecode_control="audioOnlyTimecodeControl",
            certificate_mode="certificateMode",
            connection_retry_interval=123,
            destination=medialive.CfnChannel.OutputLocationRefProperty(
                destination_ref_id="destinationRefId"
            ),
            event_id="eventId",
            event_id_mode="eventIdMode",
            event_stop_behavior="eventStopBehavior",
            filecache_duration=123,
            fragment_length=123,
            input_loss_action="inputLossAction",
            num_retries=123,
            restart_delay=123,
            segmentation_mode="segmentationMode",
            send_delay_ms=123,
            sparse_track_type="sparseTrackType",
            stream_manifest_behavior="streamManifestBehavior",
            timestamp_offset="timestampOffset",
            timestamp_offset_mode="timestampOffsetMode"
        ),
        multiplex_group_settings=medialive.CfnChannel.MultiplexGroupSettingsProperty(),
        rtmp_group_settings=medialive.CfnChannel.RtmpGroupSettingsProperty(
            ad_markers=["adMarkers"],
            authentication_scheme="authenticationScheme",
            cache_full_behavior="cacheFullBehavior",
            cache_length=123,
            caption_data="captionData",
            include_filler_nal_units="includeFillerNalUnits",
            input_loss_action="inputLossAction",
            restart_delay=123
        ),
        udp_group_settings=medialive.CfnChannel.UdpGroupSettingsProperty(
            input_loss_action="inputLossAction",
            timed_metadata_id3_frame="timedMetadataId3Frame",
            timed_metadata_id3_period=123
        )
    ),
    outputs=[medialive.CfnChannel.OutputProperty(
        audio_description_names=["audioDescriptionNames"],
        caption_description_names=["captionDescriptionNames"],
        output_name="outputName",
        output_settings=medialive.CfnChannel.OutputSettingsProperty(
            archive_output_settings=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"
            ),
            frame_capture_output_settings=medialive.CfnChannel.FrameCaptureOutputSettingsProperty(
                name_modifier="nameModifier"
            ),
            hls_output_settings=medialive.CfnChannel.HlsOutputSettingsProperty(
                h265_packaging_type="h265PackagingType",
                hls_settings=medialive.CfnChannel.HlsSettingsProperty(
                    audio_only_hls_settings=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"
                    ),
                    fmp4_hls_settings=medialive.CfnChannel.Fmp4HlsSettingsProperty(
                        audio_rendition_sets="audioRenditionSets",
                        nielsen_id3_behavior="nielsenId3Behavior",
                        timed_metadata_behavior="timedMetadataBehavior"
                    ),
                    frame_capture_hls_settings=medialive.CfnChannel.FrameCaptureHlsSettingsProperty(),
                    standard_hls_settings=medialive.CfnChannel.StandardHlsSettingsProperty(
                        audio_rendition_sets="audioRenditionSets",
                        m3_u8_settings=medialive.CfnChannel.M3u8SettingsProperty(
                            audio_frames_per_pes=123,
                            audio_pids="audioPids",
                            ecm_pid="ecmPid",
                            klv_behavior="klvBehavior",
                            klv_data_pids="klvDataPids",
                            nielsen_id3_behavior="nielsenId3Behavior",
                            pat_interval=123,
                            pcr_control="pcrControl",
                            pcr_period=123,
                            pcr_pid="pcrPid",
                            pmt_interval=123,
                            pmt_pid="pmtPid",
                            program_num=123,
                            scte35_behavior="scte35Behavior",
                            scte35_pid="scte35Pid",
                            timed_metadata_behavior="timedMetadataBehavior",
                            timed_metadata_pid="timedMetadataPid",
                            transport_stream_id=123,
                            video_pid="videoPid"
                        )
                    )
                ),
                name_modifier="nameModifier",
                segment_modifier="segmentModifier"
            ),
            media_package_output_settings=medialive.CfnChannel.MediaPackageOutputSettingsProperty(),
            ms_smooth_output_settings=medialive.CfnChannel.MsSmoothOutputSettingsProperty(
                h265_packaging_type="h265PackagingType",
                name_modifier="nameModifier"
            ),
            multiplex_output_settings=medialive.CfnChannel.MultiplexOutputSettingsProperty(
                destination=medialive.CfnChannel.OutputLocationRefProperty(
                    destination_ref_id="destinationRefId"
                )
            ),
            rtmp_output_settings=medialive.CfnChannel.RtmpOutputSettingsProperty(
                certificate_mode="certificateMode",
                connection_retry_interval=123,
                destination=medialive.CfnChannel.OutputLocationRefProperty(
                    destination_ref_id="destinationRefId"
                ),
                num_retries=123
            ),
            udp_output_settings=medialive.CfnChannel.UdpOutputSettingsProperty(
                buffer_msec=123,
                container_settings=medialive.CfnChannel.UdpContainerSettingsProperty(
                    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"
                    )
                ),
                destination=medialive.CfnChannel.OutputLocationRefProperty(
                    destination_ref_id="destinationRefId"
                ),
                fec_output_settings=medialive.CfnChannel.FecOutputSettingsProperty(
                    column_depth=123,
                    include_fec="includeFec",
                    row_length=123
                )
            )
        ),
        video_description_name="videoDescriptionName"
    )]
)

Attributes

name

A custom output group name that you can optionally define.

Only letters, numbers, and the underscore character are allowed. The maximum length is 32 characters.

See:

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

output_group_settings

The settings associated with the output group.

See:

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

outputs

The settings for the outputs in the output group.

See:

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

OutputGroupSettingsProperty

class CfnChannel.OutputGroupSettingsProperty(*, archive_group_settings=None, frame_capture_group_settings=None, hls_group_settings=None, media_package_group_settings=None, ms_smooth_group_settings=None, multiplex_group_settings=None, rtmp_group_settings=None, udp_group_settings=None)

Bases: object

The configuration of the output group.

The parent of this entity is OutputGroup.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroupsettings.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

output_group_settings_property = medialive.CfnChannel.OutputGroupSettingsProperty(
    archive_group_settings=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
    ),
    frame_capture_group_settings=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"
            )
        )
    ),
    hls_group_settings=medialive.CfnChannel.HlsGroupSettingsProperty(
        ad_markers=["adMarkers"],
        base_url_content="baseUrlContent",
        base_url_content1="baseUrlContent1",
        base_url_manifest="baseUrlManifest",
        base_url_manifest1="baseUrlManifest1",
        caption_language_mappings=[medialive.CfnChannel.CaptionLanguageMappingProperty(
            caption_channel=123,
            language_code="languageCode",
            language_description="languageDescription"
        )],
        caption_language_setting="captionLanguageSetting",
        client_cache="clientCache",
        codec_specification="codecSpecification",
        constant_iv="constantIv",
        destination=medialive.CfnChannel.OutputLocationRefProperty(
            destination_ref_id="destinationRefId"
        ),
        directory_structure="directoryStructure",
        discontinuity_tags="discontinuityTags",
        encryption_type="encryptionType",
        hls_cdn_settings=medialive.CfnChannel.HlsCdnSettingsProperty(
            hls_akamai_settings=medialive.CfnChannel.HlsAkamaiSettingsProperty(
                connection_retry_interval=123,
                filecache_duration=123,
                http_transfer_mode="httpTransferMode",
                num_retries=123,
                restart_delay=123,
                salt="salt",
                token="token"
            ),
            hls_basic_put_settings=medialive.CfnChannel.HlsBasicPutSettingsProperty(
                connection_retry_interval=123,
                filecache_duration=123,
                num_retries=123,
                restart_delay=123
            ),
            hls_media_store_settings=medialive.CfnChannel.HlsMediaStoreSettingsProperty(
                connection_retry_interval=123,
                filecache_duration=123,
                media_store_storage_class="mediaStoreStorageClass",
                num_retries=123,
                restart_delay=123
            ),
            hls_s3_settings=medialive.CfnChannel.HlsS3SettingsProperty(
                canned_acl="cannedAcl"
            ),
            hls_webdav_settings=medialive.CfnChannel.HlsWebdavSettingsProperty(
                connection_retry_interval=123,
                filecache_duration=123,
                http_transfer_mode="httpTransferMode",
                num_retries=123,
                restart_delay=123
            )
        ),
        hls_id3_segment_tagging="hlsId3SegmentTagging",
        i_frame_only_playlists="iFrameOnlyPlaylists",
        incomplete_segment_behavior="incompleteSegmentBehavior",
        index_nSegments=123,
        input_loss_action="inputLossAction",
        iv_in_manifest="ivInManifest",
        iv_source="ivSource",
        keep_segments=123,
        key_format="keyFormat",
        key_format_versions="keyFormatVersions",
        key_provider_settings=medialive.CfnChannel.KeyProviderSettingsProperty(
            static_key_settings=medialive.CfnChannel.StaticKeySettingsProperty(
                key_provider_server=medialive.CfnChannel.InputLocationProperty(
                    password_param="passwordParam",
                    uri="uri",
                    username="username"
                ),
                static_key_value="staticKeyValue"
            )
        ),
        manifest_compression="manifestCompression",
        manifest_duration_format="manifestDurationFormat",
        min_segment_length=123,
        mode="mode",
        output_selection="outputSelection",
        program_date_time="programDateTime",
        program_date_time_clock="programDateTimeClock",
        program_date_time_period=123,
        redundant_manifest="redundantManifest",
        segmentation_mode="segmentationMode",
        segment_length=123,
        segments_per_subdirectory=123,
        stream_inf_resolution="streamInfResolution",
        timed_metadata_id3_frame="timedMetadataId3Frame",
        timed_metadata_id3_period=123,
        timestamp_delta_milliseconds=123,
        ts_file_mode="tsFileMode"
    ),
    media_package_group_settings=medialive.CfnChannel.MediaPackageGroupSettingsProperty(
        destination=medialive.CfnChannel.OutputLocationRefProperty(
            destination_ref_id="destinationRefId"
        )
    ),
    ms_smooth_group_settings=medialive.CfnChannel.MsSmoothGroupSettingsProperty(
        acquisition_point_id="acquisitionPointId",
        audio_only_timecode_control="audioOnlyTimecodeControl",
        certificate_mode="certificateMode",
        connection_retry_interval=123,
        destination=medialive.CfnChannel.OutputLocationRefProperty(
            destination_ref_id="destinationRefId"
        ),
        event_id="eventId",
        event_id_mode="eventIdMode",
        event_stop_behavior="eventStopBehavior",
        filecache_duration=123,
        fragment_length=123,
        input_loss_action="inputLossAction",
        num_retries=123,
        restart_delay=123,
        segmentation_mode="segmentationMode",
        send_delay_ms=123,
        sparse_track_type="sparseTrackType",
        stream_manifest_behavior="streamManifestBehavior",
        timestamp_offset="timestampOffset",
        timestamp_offset_mode="timestampOffsetMode"
    ),
    multiplex_group_settings=medialive.CfnChannel.MultiplexGroupSettingsProperty(),
    rtmp_group_settings=medialive.CfnChannel.RtmpGroupSettingsProperty(
        ad_markers=["adMarkers"],
        authentication_scheme="authenticationScheme",
        cache_full_behavior="cacheFullBehavior",
        cache_length=123,
        caption_data="captionData",
        include_filler_nal_units="includeFillerNalUnits",
        input_loss_action="inputLossAction",
        restart_delay=123
    ),
    udp_group_settings=medialive.CfnChannel.UdpGroupSettingsProperty(
        input_loss_action="inputLossAction",
        timed_metadata_id3_frame="timedMetadataId3Frame",
        timed_metadata_id3_period=123
    )
)

Attributes

archive_group_settings

The configuration of an archive output group.

The parent of this entity is OutputGroupSettings.

See:

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

frame_capture_group_settings

The configuration of a frame capture output group.

See:

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

hls_group_settings

The configuration of an HLS output group.

See:

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

media_package_group_settings

The configuration of a MediaPackage output group.

See:

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

ms_smooth_group_settings

The configuration of a Microsoft Smooth output group.

See:

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

multiplex_group_settings

The settings for a Multiplex output group.

See:

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

rtmp_group_settings

The configuration of an RTMP output group.

See:

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

udp_group_settings

The configuration of a UDP output group.

See:

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

OutputLocationRefProperty

class CfnChannel.OutputLocationRefProperty(*, destination_ref_id=None)

Bases: object

A reference to an OutputDestination ID that is defined in the channel.

This entity is used by ArchiveGroupSettings, FrameCaptureGroupSettings, HlsGroupSettings, MediaPackageGroupSettings, MSSmoothGroupSettings, RtmpOutputSettings, and UdpOutputSettings.

Parameters:

destination_ref_id (Optional[str]) – A reference ID for this destination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputlocationref.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

output_location_ref_property = medialive.CfnChannel.OutputLocationRefProperty(
    destination_ref_id="destinationRefId"
)

Attributes

destination_ref_id

A reference ID for this destination.

See:

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

OutputLockingSettingsProperty

class CfnChannel.OutputLockingSettingsProperty(*, epoch_locking_settings=None, pipeline_locking_settings=None)

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputlockingsettings.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

output_locking_settings_property = medialive.CfnChannel.OutputLockingSettingsProperty(
    epoch_locking_settings=medialive.CfnChannel.EpochLockingSettingsProperty(
        custom_epoch="customEpoch",
        jam_sync_time="jamSyncTime"
    ),
    pipeline_locking_settings=pipeline_locking_settings
)

Attributes

epoch_locking_settings

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

Type:

see

pipeline_locking_settings

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

Type:

see

OutputProperty

class CfnChannel.OutputProperty(*, audio_description_names=None, caption_description_names=None, output_name=None, output_settings=None, video_description_name=None)

Bases: object

The output settings.

The parent of this entity is OutputGroup.

Parameters:
  • audio_description_names (Optional[Sequence[str]]) – The names of the audio descriptions that are used as audio sources for this output.

  • caption_description_names (Optional[Sequence[str]]) – The names of the caption descriptions that are used as captions sources for this output.

  • output_name (Optional[str]) – The name that is used to identify an output.

  • output_settings (Union[IResolvable, OutputSettingsProperty, Dict[str, Any], None]) – The output type-specific settings.

  • video_description_name (Optional[str]) – The name of the VideoDescription that is used as the source for this output.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-output.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

output_property = medialive.CfnChannel.OutputProperty(
    audio_description_names=["audioDescriptionNames"],
    caption_description_names=["captionDescriptionNames"],
    output_name="outputName",
    output_settings=medialive.CfnChannel.OutputSettingsProperty(
        archive_output_settings=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"
        ),
        frame_capture_output_settings=medialive.CfnChannel.FrameCaptureOutputSettingsProperty(
            name_modifier="nameModifier"
        ),
        hls_output_settings=medialive.CfnChannel.HlsOutputSettingsProperty(
            h265_packaging_type="h265PackagingType",
            hls_settings=medialive.CfnChannel.HlsSettingsProperty(
                audio_only_hls_settings=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"
                ),
                fmp4_hls_settings=medialive.CfnChannel.Fmp4HlsSettingsProperty(
                    audio_rendition_sets="audioRenditionSets",
                    nielsen_id3_behavior="nielsenId3Behavior",
                    timed_metadata_behavior="timedMetadataBehavior"
                ),
                frame_capture_hls_settings=medialive.CfnChannel.FrameCaptureHlsSettingsProperty(),
                standard_hls_settings=medialive.CfnChannel.StandardHlsSettingsProperty(
                    audio_rendition_sets="audioRenditionSets",
                    m3_u8_settings=medialive.CfnChannel.M3u8SettingsProperty(
                        audio_frames_per_pes=123,
                        audio_pids="audioPids",
                        ecm_pid="ecmPid",
                        klv_behavior="klvBehavior",
                        klv_data_pids="klvDataPids",
                        nielsen_id3_behavior="nielsenId3Behavior",
                        pat_interval=123,
                        pcr_control="pcrControl",
                        pcr_period=123,
                        pcr_pid="pcrPid",
                        pmt_interval=123,
                        pmt_pid="pmtPid",
                        program_num=123,
                        scte35_behavior="scte35Behavior",
                        scte35_pid="scte35Pid",
                        timed_metadata_behavior="timedMetadataBehavior",
                        timed_metadata_pid="timedMetadataPid",
                        transport_stream_id=123,
                        video_pid="videoPid"
                    )
                )
            ),
            name_modifier="nameModifier",
            segment_modifier="segmentModifier"
        ),
        media_package_output_settings=medialive.CfnChannel.MediaPackageOutputSettingsProperty(),
        ms_smooth_output_settings=medialive.CfnChannel.MsSmoothOutputSettingsProperty(
            h265_packaging_type="h265PackagingType",
            name_modifier="nameModifier"
        ),
        multiplex_output_settings=medialive.CfnChannel.MultiplexOutputSettingsProperty(
            destination=medialive.CfnChannel.OutputLocationRefProperty(
                destination_ref_id="destinationRefId"
            )
        ),
        rtmp_output_settings=medialive.CfnChannel.RtmpOutputSettingsProperty(
            certificate_mode="certificateMode",
            connection_retry_interval=123,
            destination=medialive.CfnChannel.OutputLocationRefProperty(
                destination_ref_id="destinationRefId"
            ),
            num_retries=123
        ),
        udp_output_settings=medialive.CfnChannel.UdpOutputSettingsProperty(
            buffer_msec=123,
            container_settings=medialive.CfnChannel.UdpContainerSettingsProperty(
                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"
                )
            ),
            destination=medialive.CfnChannel.OutputLocationRefProperty(
                destination_ref_id="destinationRefId"
            ),
            fec_output_settings=medialive.CfnChannel.FecOutputSettingsProperty(
                column_depth=123,
                include_fec="includeFec",
                row_length=123
            )
        )
    ),
    video_description_name="videoDescriptionName"
)

Attributes

audio_description_names

The names of the audio descriptions that are used as audio sources for this output.

See:

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

caption_description_names

The names of the caption descriptions that are used as captions sources for this output.

See:

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

output_name

The name that is used to identify an output.

See:

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

output_settings

The output type-specific settings.

See:

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

video_description_name

The name of the VideoDescription that is used as the source for this output.

See:

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

OutputSettingsProperty

class CfnChannel.OutputSettingsProperty(*, archive_output_settings=None, frame_capture_output_settings=None, hls_output_settings=None, media_package_output_settings=None, ms_smooth_output_settings=None, multiplex_output_settings=None, rtmp_output_settings=None, udp_output_settings=None)

Bases: object

The output settings.

The parent of this entity is Output.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputsettings.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

output_settings_property = medialive.CfnChannel.OutputSettingsProperty(
    archive_output_settings=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"
    ),
    frame_capture_output_settings=medialive.CfnChannel.FrameCaptureOutputSettingsProperty(
        name_modifier="nameModifier"
    ),
    hls_output_settings=medialive.CfnChannel.HlsOutputSettingsProperty(
        h265_packaging_type="h265PackagingType",
        hls_settings=medialive.CfnChannel.HlsSettingsProperty(
            audio_only_hls_settings=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"
            ),
            fmp4_hls_settings=medialive.CfnChannel.Fmp4HlsSettingsProperty(
                audio_rendition_sets="audioRenditionSets",
                nielsen_id3_behavior="nielsenId3Behavior",
                timed_metadata_behavior="timedMetadataBehavior"
            ),
            frame_capture_hls_settings=medialive.CfnChannel.FrameCaptureHlsSettingsProperty(),
            standard_hls_settings=medialive.CfnChannel.StandardHlsSettingsProperty(
                audio_rendition_sets="audioRenditionSets",
                m3_u8_settings=medialive.CfnChannel.M3u8SettingsProperty(
                    audio_frames_per_pes=123,
                    audio_pids="audioPids",
                    ecm_pid="ecmPid",
                    klv_behavior="klvBehavior",
                    klv_data_pids="klvDataPids",
                    nielsen_id3_behavior="nielsenId3Behavior",
                    pat_interval=123,
                    pcr_control="pcrControl",
                    pcr_period=123,
                    pcr_pid="pcrPid",
                    pmt_interval=123,
                    pmt_pid="pmtPid",
                    program_num=123,
                    scte35_behavior="scte35Behavior",
                    scte35_pid="scte35Pid",
                    timed_metadata_behavior="timedMetadataBehavior",
                    timed_metadata_pid="timedMetadataPid",
                    transport_stream_id=123,
                    video_pid="videoPid"
                )
            )
        ),
        name_modifier="nameModifier",
        segment_modifier="segmentModifier"
    ),
    media_package_output_settings=medialive.CfnChannel.MediaPackageOutputSettingsProperty(),
    ms_smooth_output_settings=medialive.CfnChannel.MsSmoothOutputSettingsProperty(
        h265_packaging_type="h265PackagingType",
        name_modifier="nameModifier"
    ),
    multiplex_output_settings=medialive.CfnChannel.MultiplexOutputSettingsProperty(
        destination=medialive.CfnChannel.OutputLocationRefProperty(
            destination_ref_id="destinationRefId"
        )
    ),
    rtmp_output_settings=medialive.CfnChannel.RtmpOutputSettingsProperty(
        certificate_mode="certificateMode",
        connection_retry_interval=123,
        destination=medialive.CfnChannel.OutputLocationRefProperty(
            destination_ref_id="destinationRefId"
        ),
        num_retries=123
    ),
    udp_output_settings=medialive.CfnChannel.UdpOutputSettingsProperty(
        buffer_msec=123,
        container_settings=medialive.CfnChannel.UdpContainerSettingsProperty(
            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"
            )
        ),
        destination=medialive.CfnChannel.OutputLocationRefProperty(
            destination_ref_id="destinationRefId"
        ),
        fec_output_settings=medialive.CfnChannel.FecOutputSettingsProperty(
            column_depth=123,
            include_fec="includeFec",
            row_length=123
        )
    )
)

Attributes

archive_output_settings

The settings for an archive output.

See:

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

frame_capture_output_settings

The settings for a frame capture output.

The parent of this entity is OutputGroupSettings.

See:

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

hls_output_settings

The settings for an HLS output.

The parent of this entity is OutputGroupSettings.

See:

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

media_package_output_settings

The settings for a MediaPackage output.

The parent of this entity is OutputGroupSettings.

See:

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

ms_smooth_output_settings

The settings for a Microsoft Smooth output.

See:

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

multiplex_output_settings

Configuration of a Multiplex output.

See:

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

rtmp_output_settings

The settings for an RTMP output.

The parent of this entity is OutputGroupSettings.

See:

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

udp_output_settings

The settings for a UDP output.

The parent of this entity is OutputGroupSettings.

See:

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

PassThroughSettingsProperty

class CfnChannel.PassThroughSettingsProperty

Bases: object

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-passthroughsettings.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

pass_through_settings_property = medialive.CfnChannel.PassThroughSettingsProperty()

RawSettingsProperty

class CfnChannel.RawSettingsProperty

Bases: object

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rawsettings.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

raw_settings_property = medialive.CfnChannel.RawSettingsProperty()

Rec601SettingsProperty

class CfnChannel.Rec601SettingsProperty

Bases: object

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rec601settings.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

rec601_settings_property = medialive.CfnChannel.Rec601SettingsProperty()

Rec709SettingsProperty

class CfnChannel.Rec709SettingsProperty

Bases: object

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rec709settings.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

rec709_settings_property = medialive.CfnChannel.Rec709SettingsProperty()

RemixSettingsProperty

class CfnChannel.RemixSettingsProperty(*, channel_mappings=None, channels_in=None, channels_out=None)

Bases: object

The settings for remixing audio in the output.

The parent of this entity is AudioDescription.

Parameters:
  • channel_mappings (Union[IResolvable, Sequence[Union[IResolvable, AudioChannelMappingProperty, Dict[str, Any]]], None]) – A mapping of input channels to output channels, with appropriate gain adjustments.

  • channels_in (Union[int, float, None]) – The number of input channels to be used.

  • channels_out (Union[int, float, None]) – The number of output channels to be produced. Valid values: 1, 2, 4, 6, 8.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-remixsettings.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

remix_settings_property = 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
)

Attributes

channel_mappings

A mapping of input channels to output channels, with appropriate gain adjustments.

See:

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

channels_in

The number of input channels to be used.

See:

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

channels_out

The number of output channels to be produced.

Valid values: 1, 2, 4, 6, 8.

See:

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

RtmpCaptionInfoDestinationSettingsProperty

class CfnChannel.RtmpCaptionInfoDestinationSettingsProperty

Bases: object

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpcaptioninfodestinationsettings.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

rtmp_caption_info_destination_settings_property = medialive.CfnChannel.RtmpCaptionInfoDestinationSettingsProperty()

RtmpGroupSettingsProperty

class CfnChannel.RtmpGroupSettingsProperty(*, ad_markers=None, authentication_scheme=None, cache_full_behavior=None, cache_length=None, caption_data=None, include_filler_nal_units=None, input_loss_action=None, restart_delay=None)

Bases: object

The configuration of an RTMP output group.

The parent of this entity is OutputGroupSettings.

Parameters:
  • ad_markers (Optional[Sequence[str]]) – Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream.

  • authentication_scheme (Optional[str]) – An authentication scheme to use when connecting with a CDN.

  • cache_full_behavior (Optional[str]) – Controls behavior when the content cache fills up. If a remote origin server stalls the RTMP connection and doesn’t accept content fast enough, the media cache fills up. When the cache reaches the duration specified by cacheLength, the cache stops accepting new content. If set to disconnectImmediately, the RTMP output forces a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output waits up to 5 minutes to allow the origin server to begin accepting data again.

  • cache_length (Union[int, float, None]) – The cache length, in seconds, that is used to calculate buffer size.

  • caption_data (Optional[str]) – Controls the types of data that pass to onCaptionInfo outputs. If set to all, 608 and 708 carried DTVCC data is passed. If set to field1AndField2608, DTVCC data is stripped out, but 608 data from both fields is passed. If set to field1608, only the data carried in 608 from field 1 video is passed.

  • include_filler_nal_units (Optional[str]) –

  • input_loss_action (Optional[str]) – Controls the behavior of this RTMP group if the input becomes unavailable. emitOutput: Emit a slate until the input returns. pauseOutput: Stop transmitting data until the input returns. This does not close the underlying RTMP connection.

  • restart_delay (Union[int, float, None]) – If a streaming output fails, the number of seconds to wait until a restart is initiated. A value of 0 means never restart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.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

rtmp_group_settings_property = medialive.CfnChannel.RtmpGroupSettingsProperty(
    ad_markers=["adMarkers"],
    authentication_scheme="authenticationScheme",
    cache_full_behavior="cacheFullBehavior",
    cache_length=123,
    caption_data="captionData",
    include_filler_nal_units="includeFillerNalUnits",
    input_loss_action="inputLossAction",
    restart_delay=123
)

Attributes

ad_markers

Choose the ad marker type for this output group.

MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream.

See:

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

authentication_scheme

An authentication scheme to use when connecting with a CDN.

See:

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

cache_full_behavior

Controls behavior when the content cache fills up.

If a remote origin server stalls the RTMP connection and doesn’t accept content fast enough, the media cache fills up. When the cache reaches the duration specified by cacheLength, the cache stops accepting new content. If set to disconnectImmediately, the RTMP output forces a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output waits up to 5 minutes to allow the origin server to begin accepting data again.

See:

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

cache_length

The cache length, in seconds, that is used to calculate buffer size.

See:

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

caption_data

Controls the types of data that pass to onCaptionInfo outputs.

If set to all, 608 and 708 carried DTVCC data is passed. If set to field1AndField2608, DTVCC data is stripped out, but 608 data from both fields is passed. If set to field1608, only the data carried in 608 from field 1 video is passed.

See:

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

include_filler_nal_units

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

Type:

see

input_loss_action

Controls the behavior of this RTMP group if the input becomes unavailable.

emitOutput: Emit a slate until the input returns. pauseOutput: Stop transmitting data until the input returns. This does not close the underlying RTMP connection.

See:

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

restart_delay

If a streaming output fails, the number of seconds to wait until a restart is initiated.

A value of 0 means never restart.

See:

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

RtmpOutputSettingsProperty

class CfnChannel.RtmpOutputSettingsProperty(*, certificate_mode=None, connection_retry_interval=None, destination=None, num_retries=None)

Bases: object

The settings for one RTMP output.

The parent of this entity is OutputSettings.

Parameters:
  • certificate_mode (Optional[str]) – If set to verifyAuthenticity, verifies the TLS certificate chain to a trusted certificate authority (CA). This causes RTMPS outputs with self-signed certificates to fail.

  • connection_retry_interval (Union[int, float, None]) – The number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.

  • destination (Union[IResolvable, OutputLocationRefProperty, Dict[str, Any], None]) – The RTMP endpoint excluding the stream name (for example, rtmp://host/appname).

  • num_retries (Union[int, float, None]) – The number of retry attempts.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpoutputsettings.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

rtmp_output_settings_property = medialive.CfnChannel.RtmpOutputSettingsProperty(
    certificate_mode="certificateMode",
    connection_retry_interval=123,
    destination=medialive.CfnChannel.OutputLocationRefProperty(
        destination_ref_id="destinationRefId"
    ),
    num_retries=123
)

Attributes

certificate_mode

If set to verifyAuthenticity, verifies the TLS certificate chain to a trusted certificate authority (CA).

This causes RTMPS outputs with self-signed certificates to fail.

See:

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

connection_retry_interval

The number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.

See:

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

destination

//host/appname).

See:

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

Type:

The RTMP endpoint excluding the stream name (for example, rtmp

num_retries

The number of retry attempts.

See:

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

Scte20PlusEmbeddedDestinationSettingsProperty

class CfnChannel.Scte20PlusEmbeddedDestinationSettingsProperty

Bases: object

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte20plusembeddeddestinationsettings.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

scte20_plus_embedded_destination_settings_property = medialive.CfnChannel.Scte20PlusEmbeddedDestinationSettingsProperty()

Scte20SourceSettingsProperty

class CfnChannel.Scte20SourceSettingsProperty(*, convert608_to708=None, source608_channel_number=None)

Bases: object

Information about the SCTE-20 captions to extract from the input.

The parent of this entity is CaptionSelectorSettings.

Parameters:
  • convert608_to708 (Optional[str]) – If upconvert, 608 data is both passed through the “608 compatibility bytes” fields of the 708 wrapper as well as translated into 708. Any 708 data present in the source content is discarded.

  • source608_channel_number (Union[int, float, None]) – Specifies the 608/708 channel number within the video track from which to extract captions.

See:

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

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

scte20_source_settings_property = medialive.CfnChannel.Scte20SourceSettingsProperty(
    convert608_to708="convert608To708",
    source608_channel_number=123
)

Attributes

convert608_to708

If upconvert, 608 data is both passed through the “608 compatibility bytes” fields of the 708 wrapper as well as translated into 708.

Any 708 data present in the source content is discarded.

See:

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

source608_channel_number

Specifies the 608/708 channel number within the video track from which to extract captions.

See:

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

Scte27DestinationSettingsProperty

class CfnChannel.Scte27DestinationSettingsProperty

Bases: object

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte27destinationsettings.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

scte27_destination_settings_property = medialive.CfnChannel.Scte27DestinationSettingsProperty()

Scte27SourceSettingsProperty

class CfnChannel.Scte27SourceSettingsProperty(*, ocr_language=None, pid=None)

Bases: object

Information about the SCTE-27 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]) – The PID field is used in conjunction with the captions selector languageCode field as follows: Specify PID and Language: Extracts captions from that PID; the language is “informational.” Specify PID and omit Language: Extracts the specified PID. Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages are passed through.

See:

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

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

scte27_source_settings_property = medialive.CfnChannel.Scte27SourceSettingsProperty(
    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-scte27sourcesettings.html#cfn-medialive-channel-scte27sourcesettings-ocrlanguage

pid

Extracts captions from that PID;

the language is “informational.” Specify PID and omit Language: Extracts the specified PID. Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages are passed through.

See:

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

Type:

The PID field is used in conjunction with the captions selector languageCode field as follows

Type:

Specify PID and Language

Scte35SpliceInsertProperty

class CfnChannel.Scte35SpliceInsertProperty(*, ad_avail_offset=None, no_regional_blackout_flag=None, web_delivery_allowed_flag=None)

Bases: object

The setup of SCTE-35 splice insert handling.

The parent of this entity is AvailSettings.

Parameters:
  • ad_avail_offset (Union[int, float, None]) – When specified, this offset (in milliseconds) is added to the input ad avail PTS time. This applies only to embedded SCTE 104/35 messages. It doesn’t apply to OOB messages.

  • no_regional_blackout_flag (Optional[str]) – When set to ignore, segment descriptors with noRegionalBlackoutFlag set to 0 no longer trigger blackouts or ad avail slates.

  • web_delivery_allowed_flag (Optional[str]) – When set to ignore, segment descriptors with webDeliveryAllowedFlag set to 0 no longer trigger blackouts or ad avail slates.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte35spliceinsert.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

scte35_splice_insert_property = medialive.CfnChannel.Scte35SpliceInsertProperty(
    ad_avail_offset=123,
    no_regional_blackout_flag="noRegionalBlackoutFlag",
    web_delivery_allowed_flag="webDeliveryAllowedFlag"
)

Attributes

ad_avail_offset

When specified, this offset (in milliseconds) is added to the input ad avail PTS time.

This applies only to embedded SCTE 104/35 messages. It doesn’t apply to OOB messages.

See:

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

no_regional_blackout_flag

When set to ignore, segment descriptors with noRegionalBlackoutFlag set to 0 no longer trigger blackouts or ad avail slates.

See:

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

web_delivery_allowed_flag

When set to ignore, segment descriptors with webDeliveryAllowedFlag set to 0 no longer trigger blackouts or ad avail slates.

See:

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

Scte35TimeSignalAposProperty

class CfnChannel.Scte35TimeSignalAposProperty(*, ad_avail_offset=None, no_regional_blackout_flag=None, web_delivery_allowed_flag=None)

Bases: object

The settings for the SCTE-35 time signal APOS mode.

The parent of this entity is AvailSettings.

Parameters:
  • ad_avail_offset (Union[int, float, None]) – When specified, this offset (in milliseconds) is added to the input ad avail PTS time. This applies only to embedded SCTE 104/35 messages. It doesn’t apply to OOB messages.

  • no_regional_blackout_flag (Optional[str]) – When set to ignore, segment descriptors with noRegionalBlackoutFlag set to 0 no longer trigger blackouts or ad avail slates.

  • web_delivery_allowed_flag (Optional[str]) – When set to ignore, segment descriptors with webDeliveryAllowedFlag set to 0 no longer trigger blackouts or ad avail slates.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte35timesignalapos.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

scte35_time_signal_apos_property = medialive.CfnChannel.Scte35TimeSignalAposProperty(
    ad_avail_offset=123,
    no_regional_blackout_flag="noRegionalBlackoutFlag",
    web_delivery_allowed_flag="webDeliveryAllowedFlag"
)

Attributes

ad_avail_offset

When specified, this offset (in milliseconds) is added to the input ad avail PTS time.

This applies only to embedded SCTE 104/35 messages. It doesn’t apply to OOB messages.

See:

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

no_regional_blackout_flag

When set to ignore, segment descriptors with noRegionalBlackoutFlag set to 0 no longer trigger blackouts or ad avail slates.

See:

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

web_delivery_allowed_flag

When set to ignore, segment descriptors with webDeliveryAllowedFlag set to 0 no longer trigger blackouts or ad avail slates.

See:

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

SmpteTtDestinationSettingsProperty

class CfnChannel.SmpteTtDestinationSettingsProperty

Bases: object

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-smptettdestinationsettings.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

smpte_tt_destination_settings_property = medialive.CfnChannel.SmpteTtDestinationSettingsProperty()

StandardHlsSettingsProperty

class CfnChannel.StandardHlsSettingsProperty(*, audio_rendition_sets=None, m3_u8_settings=None)

Bases: object

The configuration of an HLS output that is a standard output (not an audio-only output).

The parent of this entity is HlsSettings.

Parameters:
  • audio_rendition_sets (Optional[str]) – Lists all the audio groups that are used with the video output stream. This inputs all the audio GROUP-IDs that are associated with the video, separated by a comma (,).

  • m3_u8_settings (Union[IResolvable, M3u8SettingsProperty, Dict[str, Any], None]) – Settings for the M3U8 container.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-standardhlssettings.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

standard_hls_settings_property = medialive.CfnChannel.StandardHlsSettingsProperty(
    audio_rendition_sets="audioRenditionSets",
    m3_u8_settings=medialive.CfnChannel.M3u8SettingsProperty(
        audio_frames_per_pes=123,
        audio_pids="audioPids",
        ecm_pid="ecmPid",
        klv_behavior="klvBehavior",
        klv_data_pids="klvDataPids",
        nielsen_id3_behavior="nielsenId3Behavior",
        pat_interval=123,
        pcr_control="pcrControl",
        pcr_period=123,
        pcr_pid="pcrPid",
        pmt_interval=123,
        pmt_pid="pmtPid",
        program_num=123,
        scte35_behavior="scte35Behavior",
        scte35_pid="scte35Pid",
        timed_metadata_behavior="timedMetadataBehavior",
        timed_metadata_pid="timedMetadataPid",
        transport_stream_id=123,
        video_pid="videoPid"
    )
)

Attributes

audio_rendition_sets

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

This inputs all the audio GROUP-IDs that are associated with the video, separated by a comma (,).

See:

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

m3_u8_settings

Settings for the M3U8 container.

See:

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

StaticKeySettingsProperty

class CfnChannel.StaticKeySettingsProperty(*, key_provider_server=None, static_key_value=None)

Bases: object

The static key settings.

The parent of this entity is KeyProviderSettings.

Parameters:
  • key_provider_server (Union[IResolvable, InputLocationProperty, Dict[str, Any], None]) – The URL of the license server that is used for protecting content.

  • static_key_value (Optional[str]) – The static key value as a 32 character hexadecimal string.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-statickeysettings.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

static_key_settings_property = medialive.CfnChannel.StaticKeySettingsProperty(
    key_provider_server=medialive.CfnChannel.InputLocationProperty(
        password_param="passwordParam",
        uri="uri",
        username="username"
    ),
    static_key_value="staticKeyValue"
)

Attributes

key_provider_server

The URL of the license server that is used for protecting content.

See:

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

static_key_value

The static key value as a 32 character hexadecimal string.

See:

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

TeletextDestinationSettingsProperty

class CfnChannel.TeletextDestinationSettingsProperty

Bases: object

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-teletextdestinationsettings.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

teletext_destination_settings_property = medialive.CfnChannel.TeletextDestinationSettingsProperty()

TeletextSourceSettingsProperty

class CfnChannel.TeletextSourceSettingsProperty(*, output_rectangle=None, page_number=None)

Bases: object

Information about the Teletext captions to extract from the input.

The parent of this entity is CaptionSelectorSettings.

Parameters:
  • output_rectangle (Union[IResolvable, CaptionRectangleProperty, Dict[str, Any], None]) – Settings to configure the caption rectangle for an output captions that will be created using this Teletext source captions.

  • page_number (Optional[str]) – Specifies the Teletext page number within the data stream from which to extract captions. The range is 0x100 (256) to 0x8FF (2303). This is unused for passthrough. It should be specified as a hexadecimal string with no “0x” prefix.

See:

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

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

teletext_source_settings_property = medialive.CfnChannel.TeletextSourceSettingsProperty(
    output_rectangle=medialive.CfnChannel.CaptionRectangleProperty(
        height=123,
        left_offset=123,
        top_offset=123,
        width=123
    ),
    page_number="pageNumber"
)

Attributes

output_rectangle

Settings to configure the caption rectangle for an output captions that will be created using this Teletext source captions.

See:

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

page_number

Specifies the Teletext page number within the data stream from which to extract captions.

The range is 0x100 (256) to 0x8FF (2303). This is unused for passthrough. It should be specified as a hexadecimal string with no “0x” prefix.

See:

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

TemporalFilterSettingsProperty

class CfnChannel.TemporalFilterSettingsProperty(*, post_filter_sharpening=None, strength=None)

Bases: object

Settings for the temporal filter to apply to the video.

The parents of this entity are H264FilterSettings, H265FilterSettings, and Mpeg2FilterSettings.

Parameters:
  • post_filter_sharpening (Optional[str]) – If you enable this filter, the results are the following: - If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source. - If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR.

  • strength (Optional[str]) – Choose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-temporalfiltersettings.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

temporal_filter_settings_property = medialive.CfnChannel.TemporalFilterSettingsProperty(
    post_filter_sharpening="postFilterSharpening",
    strength="strength"
)

Attributes

post_filter_sharpening
  • If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source.

  • If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR.

See:

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

Type:

If you enable this filter, the results are the following

strength

Choose a filter strength.

We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft.

See:

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

ThumbnailConfigurationProperty

class CfnChannel.ThumbnailConfigurationProperty(*, state=None)

Bases: object

Parameters:

state (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-thumbnailconfiguration.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

thumbnail_configuration_property = medialive.CfnChannel.ThumbnailConfigurationProperty(
    state="state"
)

Attributes

state

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

Type:

see

TimecodeBurninSettingsProperty

class CfnChannel.TimecodeBurninSettingsProperty(*, font_size=None, position=None, prefix=None)

Bases: object

Parameters:
  • font_size (Optional[str]) –

  • position (Optional[str]) –

  • prefix (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-timecodeburninsettings.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

timecode_burnin_settings_property = medialive.CfnChannel.TimecodeBurninSettingsProperty(
    font_size="fontSize",
    position="position",
    prefix="prefix"
)

Attributes

font_size

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

Type:

see

position

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

Type:

see

prefix

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

Type:

see

TimecodeConfigProperty

class CfnChannel.TimecodeConfigProperty(*, source=None, sync_threshold=None)

Bases: object

The configuration of the timecode in the output.

The parent of this entity is EncoderSettings.

Parameters:
  • source (Optional[str]) – Identifies the source for the timecode that will be associated with the channel outputs. Embedded (embedded): Initialize the output timecode with timecode from the source. If no embedded timecode is detected in the source, the system falls back to using “Start at 0” (zerobased). System Clock (systemclock): Use the UTC time. Start at 0 (zerobased): The time of the first frame of the channel will be 00:00:00:00.

  • sync_threshold (Union[int, float, None]) – The threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. There is no timecode sync when this is not specified.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-timecodeconfig.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

timecode_config_property = medialive.CfnChannel.TimecodeConfigProperty(
    source="source",
    sync_threshold=123
)

Attributes

source

Identifies the source for the timecode that will be associated with the channel outputs.

Embedded (embedded): Initialize the output timecode with timecode from the source. If no embedded timecode is detected in the source, the system falls back to using “Start at 0” (zerobased). System Clock (systemclock): Use the UTC time. Start at 0 (zerobased): The time of the first frame of the channel will be 00:00:00:00.

See:

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

sync_threshold

The threshold in frames beyond which output timecode is resynchronized to the input timecode.

Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. There is no timecode sync when this is not specified.

See:

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

TtmlDestinationSettingsProperty

class CfnChannel.TtmlDestinationSettingsProperty(*, style_control=None)

Bases: object

The setup of TTML captions in the output.

The parent of this entity is CaptionDestinationSettings.

Parameters:

style_control (Optional[str]) – When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ttmldestinationsettings.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

ttml_destination_settings_property = medialive.CfnChannel.TtmlDestinationSettingsProperty(
    style_control="styleControl"
)

Attributes

style_control

When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.

See:

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

UdpContainerSettingsProperty

class CfnChannel.UdpContainerSettingsProperty(*, m2_ts_settings=None)

Bases: object

The configuration of a UDP output.

The parent of this entity is UdpOutputSettings.

Parameters:

m2_ts_settings (Union[IResolvable, M2tsSettingsProperty, Dict[str, Any], None]) – The M2TS configuration for this UDP output.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-udpcontainersettings.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

udp_container_settings_property = medialive.CfnChannel.UdpContainerSettingsProperty(
    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"
    )
)

Attributes

m2_ts_settings

The M2TS configuration for this UDP output.

See:

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

UdpGroupSettingsProperty

class CfnChannel.UdpGroupSettingsProperty(*, input_loss_action=None, timed_metadata_id3_frame=None, timed_metadata_id3_period=None)

Bases: object

The configuration of a UDP output group.

The parent of this entity is OutputGroupSettings.

Parameters:
  • input_loss_action (Optional[str]) – Specifies the behavior of the last resort when the input video is lost, and no more backup inputs are available. When dropTs is selected, the entire transport stream stops emitting. When dropProgram is selected, the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or when emitProgram is selected, the transport stream continues to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.

  • timed_metadata_id3_frame (Optional[str]) – Indicates the ID3 frame that has the timecode.

  • timed_metadata_id3_period (Union[int, float, None]) – The timed metadata interval in seconds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-udpgroupsettings.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

udp_group_settings_property = medialive.CfnChannel.UdpGroupSettingsProperty(
    input_loss_action="inputLossAction",
    timed_metadata_id3_frame="timedMetadataId3Frame",
    timed_metadata_id3_period=123
)

Attributes

input_loss_action

Specifies the behavior of the last resort when the input video is lost, and no more backup inputs are available.

When dropTs is selected, the entire transport stream stops emitting. When dropProgram is selected, the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or when emitProgram is selected, the transport stream continues to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.

See:

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

timed_metadata_id3_frame

Indicates the ID3 frame that has the timecode.

See:

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

timed_metadata_id3_period

The timed metadata interval in seconds.

See:

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

UdpOutputSettingsProperty

class CfnChannel.UdpOutputSettingsProperty(*, buffer_msec=None, container_settings=None, destination=None, fec_output_settings=None)

Bases: object

The settings for one UDP output.

The parent of this entity is OutputSettings.

Parameters:
  • buffer_msec (Union[int, float, None]) – The UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, and so on.

  • container_settings (Union[IResolvable, UdpContainerSettingsProperty, Dict[str, Any], None]) – The settings for the UDP output.

  • destination (Union[IResolvable, OutputLocationRefProperty, Dict[str, Any], None]) – The destination address and port number for RTP or UDP packets. These can be unicast or multicast RTP or UDP (for example, rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).

  • fec_output_settings (Union[IResolvable, FecOutputSettingsProperty, Dict[str, Any], None]) – The settings for enabling and adjusting Forward Error Correction on UDP outputs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-udpoutputsettings.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

udp_output_settings_property = medialive.CfnChannel.UdpOutputSettingsProperty(
    buffer_msec=123,
    container_settings=medialive.CfnChannel.UdpContainerSettingsProperty(
        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"
        )
    ),
    destination=medialive.CfnChannel.OutputLocationRefProperty(
        destination_ref_id="destinationRefId"
    ),
    fec_output_settings=medialive.CfnChannel.FecOutputSettingsProperty(
        column_depth=123,
        include_fec="includeFec",
        row_length=123
    )
)

Attributes

buffer_msec

The UDP output buffering in milliseconds.

Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, and so on.

See:

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

container_settings

The settings for the UDP output.

See:

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

destination

The destination address and port number for RTP or UDP packets.

These can be unicast or multicast RTP or UDP (for example, rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).

See:

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

fec_output_settings

The settings for enabling and adjusting Forward Error Correction on UDP outputs.

See:

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

VideoBlackFailoverSettingsProperty

class CfnChannel.VideoBlackFailoverSettingsProperty(*, black_detect_threshold=None, video_black_threshold_msec=None)

Bases: object

MediaLive will perform a failover if content is considered black for the specified period.

The parent of this entity is FailoverConditionSettings.

Parameters:
  • black_detect_threshold (Union[int, float, None]) – A value used in calculating the threshold below which MediaLive considers a pixel to be ‘black’. For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (1023*0.1=102.3), which means a pixel value of 102 or less is ‘black’. If you set this field to .1 in an 8-bit color depth: (255*0.1=25.5), which means a pixel value of 25 or less is ‘black’. The range is 0.0 to 1.0, with any number of decimal places.

  • video_black_threshold_msec (Union[int, float, None]) – The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs.

See:

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

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

video_black_failover_settings_property = medialive.CfnChannel.VideoBlackFailoverSettingsProperty(
    black_detect_threshold=123,
    video_black_threshold_msec=123
)

Attributes

black_detect_threshold

A value used in calculating the threshold below which MediaLive considers a pixel to be ‘black’.

For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (1023*0.1=102.3), which means a pixel value of 102 or less is ‘black’. If you set this field to .1 in an 8-bit color depth: (255*0.1=25.5), which means a pixel value of 25 or less is ‘black’. The range is 0.0 to 1.0, with any number of decimal places.

See:

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

video_black_threshold_msec

The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs.

See:

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

VideoCodecSettingsProperty

class CfnChannel.VideoCodecSettingsProperty(*, frame_capture_settings=None, h264_settings=None, h265_settings=None, mpeg2_settings=None)

Bases: object

The settings for the video codec in the output.

The parent of this entity is VideoDescription.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videocodecsettings.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

video_codec_settings_property = medialive.CfnChannel.VideoCodecSettingsProperty(
    frame_capture_settings=medialive.CfnChannel.FrameCaptureSettingsProperty(
        capture_interval=123,
        capture_interval_units="captureIntervalUnits",
        timecode_burnin_settings=medialive.CfnChannel.TimecodeBurninSettingsProperty(
            font_size="fontSize",
            position="position",
            prefix="prefix"
        )
    ),
    h264_settings=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"
    ),
    h265_settings=medialive.CfnChannel.H265SettingsProperty(
        adaptive_quantization="adaptiveQuantization",
        afd_signaling="afdSignaling",
        alternative_transfer_function="alternativeTransferFunction",
        bitrate=123,
        buf_size=123,
        color_metadata="colorMetadata",
        color_space_settings=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()
        ),
        filter_settings=medialive.CfnChannel.H265FilterSettingsProperty(
            temporal_filter_settings=medialive.CfnChannel.TemporalFilterSettingsProperty(
                post_filter_sharpening="postFilterSharpening",
                strength="strength"
            )
        ),
        fixed_afd="fixedAfd",
        flicker_aq="flickerAq",
        framerate_denominator=123,
        framerate_numerator=123,
        gop_closed_cadence=123,
        gop_size=123,
        gop_size_units="gopSizeUnits",
        level="level",
        look_ahead_rate_control="lookAheadRateControl",
        max_bitrate=123,
        min_iInterval=123,
        par_denominator=123,
        par_numerator=123,
        profile="profile",
        qvbr_quality_level=123,
        rate_control_mode="rateControlMode",
        scan_type="scanType",
        scene_change_detect="sceneChangeDetect",
        slices=123,
        tier="tier",
        timecode_burnin_settings=medialive.CfnChannel.TimecodeBurninSettingsProperty(
            font_size="fontSize",
            position="position",
            prefix="prefix"
        ),
        timecode_insertion="timecodeInsertion"
    ),
    mpeg2_settings=medialive.CfnChannel.Mpeg2SettingsProperty(
        adaptive_quantization="adaptiveQuantization",
        afd_signaling="afdSignaling",
        color_metadata="colorMetadata",
        color_space="colorSpace",
        display_aspect_ratio="displayAspectRatio",
        filter_settings=medialive.CfnChannel.Mpeg2FilterSettingsProperty(
            temporal_filter_settings=medialive.CfnChannel.TemporalFilterSettingsProperty(
                post_filter_sharpening="postFilterSharpening",
                strength="strength"
            )
        ),
        fixed_afd="fixedAfd",
        framerate_denominator=123,
        framerate_numerator=123,
        gop_closed_cadence=123,
        gop_num_bFrames=123,
        gop_size=123,
        gop_size_units="gopSizeUnits",
        scan_type="scanType",
        subgop_length="subgopLength",
        timecode_burnin_settings=medialive.CfnChannel.TimecodeBurninSettingsProperty(
            font_size="fontSize",
            position="position",
            prefix="prefix"
        ),
        timecode_insertion="timecodeInsertion"
    )
)

Attributes

frame_capture_settings

The settings for the video codec in a frame capture output.

See:

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

h264_settings

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

See:

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

h265_settings

Settings for video encoded with the H265 codec.

See:

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

mpeg2_settings

Settings for video encoded with the MPEG-2 codec.

See:

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

VideoDescriptionProperty

class CfnChannel.VideoDescriptionProperty(*, codec_settings=None, height=None, name=None, respond_to_afd=None, scaling_behavior=None, sharpness=None, width=None)

Bases: object

Encoding information for one output video.

The parent of this entity is EncoderSettings.

Parameters:
  • codec_settings (Union[IResolvable, VideoCodecSettingsProperty, Dict[str, Any], None]) – The video codec settings.

  • height (Union[int, float, None]) – The output video height, in pixels. This must be an even number. For most codecs, you can keep this field and width blank in order to use the height and width (resolution) from the source. Note that we don’t recommend keeping the field blank. For the Frame Capture codec, height and width are required.

  • name (Optional[str]) – The name of this VideoDescription. Outputs use this name to uniquely identify this description. Description names should be unique within this channel.

  • respond_to_afd (Optional[str]) – Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for the FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.

  • scaling_behavior (Optional[str]) – STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option overrides any position value. DEFAULT might insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.

  • sharpness (Union[int, float, None]) – Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, and 100 is the sharpest. We recommend a setting of 50 for most content.

  • width (Union[int, float, None]) – The output video width, in pixels. It must be an even number. For most codecs, you can keep this field and height blank in order to use the height and width (resolution) from the source. Note that we don’t recommend keeping the field blank. For the Frame Capture codec, height and width are required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videodescription.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

video_description_property = medialive.CfnChannel.VideoDescriptionProperty(
    codec_settings=medialive.CfnChannel.VideoCodecSettingsProperty(
        frame_capture_settings=medialive.CfnChannel.FrameCaptureSettingsProperty(
            capture_interval=123,
            capture_interval_units="captureIntervalUnits",
            timecode_burnin_settings=medialive.CfnChannel.TimecodeBurninSettingsProperty(
                font_size="fontSize",
                position="position",
                prefix="prefix"
            )
        ),
        h264_settings=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"
        ),
        h265_settings=medialive.CfnChannel.H265SettingsProperty(
            adaptive_quantization="adaptiveQuantization",
            afd_signaling="afdSignaling",
            alternative_transfer_function="alternativeTransferFunction",
            bitrate=123,
            buf_size=123,
            color_metadata="colorMetadata",
            color_space_settings=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()
            ),
            filter_settings=medialive.CfnChannel.H265FilterSettingsProperty(
                temporal_filter_settings=medialive.CfnChannel.TemporalFilterSettingsProperty(
                    post_filter_sharpening="postFilterSharpening",
                    strength="strength"
                )
            ),
            fixed_afd="fixedAfd",
            flicker_aq="flickerAq",
            framerate_denominator=123,
            framerate_numerator=123,
            gop_closed_cadence=123,
            gop_size=123,
            gop_size_units="gopSizeUnits",
            level="level",
            look_ahead_rate_control="lookAheadRateControl",
            max_bitrate=123,
            min_iInterval=123,
            par_denominator=123,
            par_numerator=123,
            profile="profile",
            qvbr_quality_level=123,
            rate_control_mode="rateControlMode",
            scan_type="scanType",
            scene_change_detect="sceneChangeDetect",
            slices=123,
            tier="tier",
            timecode_burnin_settings=medialive.CfnChannel.TimecodeBurninSettingsProperty(
                font_size="fontSize",
                position="position",
                prefix="prefix"
            ),
            timecode_insertion="timecodeInsertion"
        ),
        mpeg2_settings=medialive.CfnChannel.Mpeg2SettingsProperty(
            adaptive_quantization="adaptiveQuantization",
            afd_signaling="afdSignaling",
            color_metadata="colorMetadata",
            color_space="colorSpace",
            display_aspect_ratio="displayAspectRatio",
            filter_settings=medialive.CfnChannel.Mpeg2FilterSettingsProperty(
                temporal_filter_settings=medialive.CfnChannel.TemporalFilterSettingsProperty(
                    post_filter_sharpening="postFilterSharpening",
                    strength="strength"
                )
            ),
            fixed_afd="fixedAfd",
            framerate_denominator=123,
            framerate_numerator=123,
            gop_closed_cadence=123,
            gop_num_bFrames=123,
            gop_size=123,
            gop_size_units="gopSizeUnits",
            scan_type="scanType",
            subgop_length="subgopLength",
            timecode_burnin_settings=medialive.CfnChannel.TimecodeBurninSettingsProperty(
                font_size="fontSize",
                position="position",
                prefix="prefix"
            ),
            timecode_insertion="timecodeInsertion"
        )
    ),
    height=123,
    name="name",
    respond_to_afd="respondToAfd",
    scaling_behavior="scalingBehavior",
    sharpness=123,
    width=123
)

Attributes

codec_settings

The video codec settings.

See:

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

height

The output video height, in pixels.

This must be an even number. For most codecs, you can keep this field and width blank in order to use the height and width (resolution) from the source. Note that we don’t recommend keeping the field blank. For the Frame Capture codec, height and width are required.

See:

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

name

The name of this VideoDescription.

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

See:

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

respond_to_afd

Indicates how to respond to the AFD values in the input stream.

RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for the FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.

See:

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

scaling_behavior

STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width).

This option overrides any position value. DEFAULT might insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.

See:

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

sharpness

Changes the strength of the anti-alias filter used for scaling.

0 is the softest setting, and 100 is the sharpest. We recommend a setting of 50 for most content.

See:

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

width

The output video width, in pixels.

It must be an even number. For most codecs, you can keep this field and height blank in order to use the height and width (resolution) from the source. Note that we don’t recommend keeping the field blank. For the Frame Capture codec, height and width are required.

See:

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

VideoSelectorColorSpaceSettingsProperty

class CfnChannel.VideoSelectorColorSpaceSettingsProperty(*, hdr10_settings=None)

Bases: object

Settings to configure color space settings in the incoming video.

The parent of this entity is VideoSelector.

Parameters:

hdr10_settings (Union[IResolvable, Hdr10SettingsProperty, Dict[str, Any], None]) – Settings to configure color space settings in the incoming video.

See:

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

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

video_selector_color_space_settings_property = medialive.CfnChannel.VideoSelectorColorSpaceSettingsProperty(
    hdr10_settings=medialive.CfnChannel.Hdr10SettingsProperty(
        max_cll=123,
        max_fall=123
    )
)

Attributes

hdr10_settings

Settings to configure color space settings in the incoming video.

See:

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

VideoSelectorPidProperty

class CfnChannel.VideoSelectorPidProperty(*, pid=None)

Bases: object

Selects a specific PID from within a video source.

The parent of this entity is VideoSelectorSettings.

Parameters:

pid (Union[int, float, None]) – Selects a specific PID from within a video source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorpid.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

video_selector_pid_property = medialive.CfnChannel.VideoSelectorPidProperty(
    pid=123
)

Attributes

pid

Selects a specific PID from within a video source.

See:

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

VideoSelectorProgramIdProperty

class CfnChannel.VideoSelectorProgramIdProperty(*, program_id=None)

Bases: object

Used to extract video by the program ID.

The parent of this entity is VideoSelectorSettings.

Parameters:

program_id (Union[int, float, None]) – Selects a specific program from within a multi-program transport stream. If the program doesn’t exist, MediaLive selects the first program within the transport stream by default.

See:

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

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

video_selector_program_id_property = medialive.CfnChannel.VideoSelectorProgramIdProperty(
    program_id=123
)

Attributes

program_id

Selects a specific program from within a multi-program transport stream.

If the program doesn’t exist, MediaLive selects the first program within the transport stream by default.

See:

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

VideoSelectorProperty

class CfnChannel.VideoSelectorProperty(*, color_space=None, color_space_settings=None, color_space_usage=None, selector_settings=None)

Bases: object

Information about the video to extract from the input. An input can contain only one video selector.

The parent of this entity is InputSettings.

Parameters:
  • color_space (Optional[str]) – Specifies the color space of an input. This setting works in tandem with colorSpaceConversion to determine if MediaLive will perform any conversion.

  • color_space_settings (Union[IResolvable, VideoSelectorColorSpaceSettingsProperty, Dict[str, Any], None]) – Settings to configure color space settings in the incoming video.

  • color_space_usage (Optional[str]) – Applies only if colorSpace is a value other than Follow. This field controls how the value in the colorSpace field is used. Fallback means that when the input does include color space data, that data is used, but when the input has no color space data, the value in colorSpace is used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. Force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.

  • selector_settings (Union[IResolvable, VideoSelectorSettingsProperty, Dict[str, Any], None]) – Information about the video to select from the content.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.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

video_selector_property = medialive.CfnChannel.VideoSelectorProperty(
    color_space="colorSpace",
    color_space_settings=medialive.CfnChannel.VideoSelectorColorSpaceSettingsProperty(
        hdr10_settings=medialive.CfnChannel.Hdr10SettingsProperty(
            max_cll=123,
            max_fall=123
        )
    ),
    color_space_usage="colorSpaceUsage",
    selector_settings=medialive.CfnChannel.VideoSelectorSettingsProperty(
        video_selector_pid=medialive.CfnChannel.VideoSelectorPidProperty(
            pid=123
        ),
        video_selector_program_id=medialive.CfnChannel.VideoSelectorProgramIdProperty(
            program_id=123
        )
    )
)

Attributes

color_space

Specifies the color space of an input.

This setting works in tandem with colorSpaceConversion to determine if MediaLive will perform any conversion.

See:

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

color_space_settings

Settings to configure color space settings in the incoming video.

See:

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

color_space_usage

Applies only if colorSpace is a value other than Follow.

This field controls how the value in the colorSpace field is used. Fallback means that when the input does include color space data, that data is used, but when the input has no color space data, the value in colorSpace is used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. Force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.

See:

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

selector_settings

Information about the video to select from the content.

See:

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

VideoSelectorSettingsProperty

class CfnChannel.VideoSelectorSettingsProperty(*, video_selector_pid=None, video_selector_program_id=None)

Bases: object

Information about the video to extract from the input.

The parent of this entity is VideoSelector.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorsettings.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

video_selector_settings_property = medialive.CfnChannel.VideoSelectorSettingsProperty(
    video_selector_pid=medialive.CfnChannel.VideoSelectorPidProperty(
        pid=123
    ),
    video_selector_program_id=medialive.CfnChannel.VideoSelectorProgramIdProperty(
        program_id=123
    )
)

Attributes

video_selector_pid

Used to extract video by PID.

See:

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

video_selector_program_id

Used to extract video by program ID.

See:

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

VpcOutputSettingsProperty

class CfnChannel.VpcOutputSettingsProperty(*, public_address_allocation_ids=None, security_group_ids=None, subnet_ids=None)

Bases: object

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

This entity is at the top level in the channel.

Parameters:
  • public_address_allocation_ids (Optional[Sequence[str]]) – List of public address allocation IDs to associate with ENIs that will be created in Output VPC. Must specify one for SINGLE_PIPELINE, two for STANDARD channels

  • security_group_ids (Optional[Sequence[str]]) – A list of up to 5 EC2 VPC security group IDs to attach to the Output VPC network interfaces. If none are specified then the VPC default security group will be used

  • subnet_ids (Optional[Sequence[str]]) – A list of VPC subnet IDs from the same VPC. If STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-vpcoutputsettings.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

vpc_output_settings_property = medialive.CfnChannel.VpcOutputSettingsProperty(
    public_address_allocation_ids=["publicAddressAllocationIds"],
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"]
)

Attributes

public_address_allocation_ids

List of public address allocation IDs to associate with ENIs that will be created in Output VPC.

Must specify one for SINGLE_PIPELINE, two for STANDARD channels

See:

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

security_group_ids

A list of up to 5 EC2 VPC security group IDs to attach to the Output VPC network interfaces.

If none are specified then the VPC default security group will be used

See:

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

subnet_ids

A list of VPC subnet IDs from the same VPC.

If STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ).

See:

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

WavSettingsProperty

class CfnChannel.WavSettingsProperty(*, bit_depth=None, coding_mode=None, sample_rate=None)

Bases: object

The setup of WAV audio in the output.

The parent of this entity is AudioCodecSettings.

Parameters:
  • bit_depth (Union[int, float, None]) – Bits per sample.

  • coding_mode (Optional[str]) – The audio coding mode for the WAV audio. The mode determines the number of channels in the audio.

  • sample_rate (Union[int, float, None]) – Sample rate in Hz.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-wavsettings.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

wav_settings_property = medialive.CfnChannel.WavSettingsProperty(
    bit_depth=123,
    coding_mode="codingMode",
    sample_rate=123
)

Attributes

bit_depth

Bits per sample.

See:

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

coding_mode

The audio coding mode for the WAV audio.

The mode determines the number of channels in the audio.

See:

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

sample_rate

Sample rate in Hz.

See:

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

WebvttDestinationSettingsProperty

class CfnChannel.WebvttDestinationSettingsProperty(*, style_control=None)

Bases: object

The configuration of Web VTT captions in the output.

The parent of this entity is CaptionDestinationSettings.

Parameters:

style_control (Optional[str]) – Controls whether the color and position of the source captions is passed through to the WebVTT output captions. PASSTHROUGH - Valid only if the source captions are EMBEDDED or TELETEXT. NO_STYLE_DATA - Don’t pass through the style. The output captions will not contain any font styling information.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-webvttdestinationsettings.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

webvtt_destination_settings_property = medialive.CfnChannel.WebvttDestinationSettingsProperty(
    style_control="styleControl"
)

Attributes

style_control

Controls whether the color and position of the source captions is passed through to the WebVTT output captions.

PASSTHROUGH - Valid only if the source captions are EMBEDDED or TELETEXT. NO_STYLE_DATA - Don’t pass through the style. The output captions will not contain any font styling information.

See:

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