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, name=None, role_arn=None, tags=None, vpc=None)

Bases: CfnResource

A CloudFormation AWS::MediaLive::Channel.

The AWS::MediaLive::Channel resource is a MediaLive resource type that creates a channel.

A MediaLive channel ingests and transcodes (decodes and encodes) source content from the inputs that are attached to that channel, and packages the new content into outputs.

CloudformationResource

AWS::MediaLive::Channel

Link

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

# tags: Any

cfn_channel = medialive.CfnChannel(self, "MyCfnChannel",
    cdi_input_specification=medialive.CfnChannel.CdiInputSpecificationProperty(
        resolution="resolution"
    ),
    channel_class="channelClass",
    destinations=[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"
        )]
    )],
    encoder_settings=medialive.CfnChannel.EncoderSettingsProperty(
        audio_descriptions=[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
                    )
                )
            ),
            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(
                    bitrate=123,
                    bitstream_mode="bitstreamMode",
                    coding_mode="codingMode",
                    dialnorm=123,
                    drc_profile="drcProfile",
                    lfe_filter="lfeFilter",
                    metadata_control="metadataControl"
                ),
                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"
        )],
        avail_blanking=medialive.CfnChannel.AvailBlankingProperty(
            avail_blanking_image=medialive.CfnChannel.InputLocationProperty(
                password_param="passwordParam",
                uri="uri",
                username="username"
            ),
            state="state"
        ),
        avail_configuration=medialive.CfnChannel.AvailConfigurationProperty(
            avail_settings=medialive.CfnChannel.AvailSettingsProperty(
                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"
                )
            )
        ),
        blackout_slate=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"
        ),
        caption_descriptions=[medialive.CfnChannel.CaptionDescriptionProperty(
            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"
        )],
        feature_activations=medialive.CfnChannel.FeatureActivationsProperty(
            input_prepare_schedule_actions="inputPrepareScheduleActions"
        ),
        global_configuration=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_timing_source="outputTimingSource",
            support_low_framerate_inputs="supportLowFramerateInputs"
        ),
        motion_graphics_configuration=medialive.CfnChannel.MotionGraphicsConfigurationProperty(
            motion_graphics_insertion="motionGraphicsInsertion",
            motion_graphics_settings=medialive.CfnChannel.MotionGraphicsSettingsProperty(
                html_motion_graphics_settings=medialive.CfnChannel.HtmlMotionGraphicsSettingsProperty()
            )
        ),
        nielsen_configuration=medialive.CfnChannel.NielsenConfigurationProperty(
            distributor_id="distributorId",
            nielsen_pcm_to_id3_tagging="nielsenPcmToId3Tagging"
        ),
        output_groups=[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",
                    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",
                                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",
                                    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",
                                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"
            )]
        )],
        timecode_config=medialive.CfnChannel.TimecodeConfigProperty(
            source="source",
            sync_threshold=123
        ),
        video_descriptions=[medialive.CfnChannel.VideoDescriptionProperty(
            codec_settings=medialive.CfnChannel.VideoCodecSettingsProperty(
                frame_capture_settings=medialive.CfnChannel.FrameCaptureSettingsProperty(
                    capture_interval=123,
                    capture_interval_units="captureIntervalUnits"
                ),
                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_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(),
                        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_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_insertion="timecodeInsertion"
                )
            ),
            height=123,
            name="name",
            respond_to_afd="respondToAfd",
            scaling_behavior="scalingBehavior",
            sharpness=123,
            width=123
        )]
    ),
    input_attachments=[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(
                        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
                    )
                )
            )
        )
    )],
    input_specification=medialive.CfnChannel.InputSpecificationProperty(
        codec="codec",
        maximum_bitrate="maximumBitrate",
        resolution="resolution"
    ),
    log_level="logLevel",
    name="name",
    role_arn="roleArn",
    tags=tags,
    vpc=medialive.CfnChannel.VpcOutputSettingsProperty(
        public_address_allocation_ids=["publicAddressAllocationIds"],
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
)

Create a new AWS::MediaLive::Channel.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • cdi_input_specification (Union[CdiInputSpecificationProperty, Dict[str, Any], IResolvable, None]) – Specification of CDI inputs for this channel.

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

  • destinations (Union[IResolvable, Sequence[Union[OutputDestinationProperty, Dict[str, Any], IResolvable]], None]) – The settings that identify the destination for the outputs in this MediaLive output package.

  • encoder_settings (Union[EncoderSettingsProperty, Dict[str, Any], IResolvable, None]) – The encoding configuration for the output content.

  • input_attachments (Union[IResolvable, Sequence[Union[InputAttachmentProperty, Dict[str, Any], IResolvable]], None]) – The list of input attachments for the channel.

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

  • log_level (Optional[str]) – The verbosity for logging activity for this channel. Charges for logging (which are generated through Amazon CloudWatch Logging) are higher for higher verbosities.

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

  • role_arn (Optional[str]) – The IAM role for MediaLive to assume when running this channel. The role is identified by its ARN.

  • tags (Optional[Any]) – A collection of tags for this channel. Each tag is a key-value pair.

  • vpc (Union[VpcOutputSettingsProperty, Dict[str, Any], IResolvable, None]) – 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:

# Example automatically generated from non-compiling source. May contain errors.
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 intermdediate 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 resoure, 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[CfnResource, Stack]]

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

Link

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

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.

For a channel with two pipelines, the class is STANDARD. For a channel with one pipeline, the class is SINGLE_PIPELINE.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-channelclass

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-destinations

encoder_settings

The encoding configuration for the output content.

Link

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

input_attachments

The list of input attachments for the channel.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-inputattachments

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.

Link

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

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-loglevel

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.

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.

Link

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

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.

The role is identified by its ARN.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-rolearn

stack

The stack in which this element is defined.

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

tags

A collection of tags for this channel.

Each tag is a key-value pair.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-tags

vpc

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-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(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

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.

Link

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.

Link

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.

Link

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.

Link

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

profile

The AAC profile.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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

Ac3SettingsProperty

class CfnChannel.Ac3SettingsProperty(*, 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
  • 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.

Link

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(
    bitrate=123,
    bitstream_mode="bitstreamMode",
    coding_mode="codingMode",
    dialnorm=123,
    drc_profile="drcProfile",
    lfe_filter="lfeFilter",
    metadata_control="metadataControl"
)

Attributes

bitrate

The average bitrate in bits/second.

Valid bitrates depend on the coding mode.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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[ArchiveS3SettingsProperty, Dict[str, Any], IResolvable, None]) – Sets up Amazon S3 as the destination for this Archive output.

Link

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.

Link

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
Link

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",
        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.

Link

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.

Link

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[ArchiveCdnSettingsProperty, Dict[str, Any], IResolvable, None]) – Settings to configure the destination of an Archive output.

  • destination (Union[OutputLocationRefProperty, Dict[str, Any], IResolvable, 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.

Link

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.

Link

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.

Link

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.

Link

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[ArchiveContainerSettingsProperty, Dict[str, Any], IResolvable, 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.

Link

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",
            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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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

The configuration of ARIB captions in the output.

The parent of this entity is CaptionDestinationSettings.

Link

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

Information about the ARIB captions to extract from the input.

The parent of this entity is CaptionSelectorSettings.

Link

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[InputChannelLevelProperty, Dict[str, Any], IResolvable]], 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.

Link

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.

Link

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.

Link

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_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
Link

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(
        bitrate=123,
        bitstream_mode="bitstreamMode",
        coding_mode="codingMode",
        dialnorm=123,
        drc_profile="drcProfile",
        lfe_filter="lfeFilter",
        metadata_control="metadataControl"
    ),
    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.

Link

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.

Link

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

eac3_settings

The setup of an EAC3 audio codec in the output.

Link

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.

Link

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.

Link

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.

Link

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[AudioNormalizationSettingsProperty, Dict[str, Any], IResolvable, 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[AudioWatermarkSettingsProperty, Dict[str, Any], IResolvable, None]) – Settings to configure one or more solutions that insert audio watermarks in the audio encode.

  • codec_settings (Union[AudioCodecSettingsProperty, Dict[str, Any], IResolvable, 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[RemixSettingsProperty, Dict[str, Any], IResolvable, 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).

Link

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
            )
        )
    ),
    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(
            bitrate=123,
            bitstream_mode="bitstreamMode",
            coding_mode="codingMode",
            dialnorm=123,
            drc_profile="drcProfile",
            lfe_filter="lfeFilter",
            metadata_control="metadataControl"
        ),
        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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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

Link

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

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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[InputLocationProperty, Dict[str, Any], IResolvable, 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.

Link

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.

Link

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

Link

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.

Link

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.

Link

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.

Link

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.

Link

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[AudioSelectorSettingsProperty, Dict[str, Any], IResolvable, None]) – Information about the specific audio to extract from the input.

Link

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(
            tracks=[medialive.CfnChannel.AudioTrackProperty(
                track=123
            )]
        )
    )
)

Attributes

name

A name for this AudioSelector.

Link

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.

Link

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
Link

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(
        tracks=[medialive.CfnChannel.AudioTrackProperty(
            track=123
        )]
    )
)

Attributes

audio_hls_rendition_selection

Selector for HLS audio rendition.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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

AudioTrackSelectionProperty

class CfnChannel.AudioTrackSelectionProperty(*, tracks=None)

Bases: object

Information about the audio track to extract.

The parent of this entity is AudioSelectorSettings.

Parameters

tracks (Union[IResolvable, Sequence[Union[AudioTrackProperty, Dict[str, Any], IResolvable]], None]) – Selects one or more unique audio tracks from within a source.

Link

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(
    tracks=[medialive.CfnChannel.AudioTrackProperty(
        track=123
    )]
)

Attributes

tracks

Selects one or more unique audio tracks from within a source.

Link

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[NielsenWatermarksSettingsProperty, Dict[str, Any], IResolvable, None]) – Settings to configure Nielsen Watermarks in the audio encode.

Link

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

Attributes

nielsen_watermarks_settings

Settings to configure Nielsen Watermarks in the audio encode.

Link

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[FailoverConditionProperty, Dict[str, Any], IResolvable]], 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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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[InputLocationProperty, Dict[str, Any], IResolvable, 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.

Link

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.

Link

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.

Link

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[AvailSettingsProperty, Dict[str, Any], IResolvable, None]) – The setup of ad avail handling in the output.

Link

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

Link

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

AvailSettingsProperty

class CfnChannel.AvailSettingsProperty(*, 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
Link

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

scte35_splice_insert

The setup for SCTE-35 splice insert handling.

Link

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.

Link

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[InputLocationProperty, Dict[str, Any], IResolvable, 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[InputLocationProperty, Dict[str, Any], IResolvable, 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.

Link

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.

Link

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.

Link

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.

Link

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”).

Link

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.

Link

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[InputLocationProperty, Dict[str, Any], IResolvable, 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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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

CaptionDescriptionProperty

class CfnChannel.CaptionDescriptionProperty(*, 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
  • 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[CaptionDestinationSettingsProperty, Dict[str, Any], IResolvable, 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.

Link

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

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.

Link

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.

Link

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

Link

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

Link

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.

Link

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
Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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

Link

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

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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[CaptionSelectorSettingsProperty, Dict[str, Any], IResolvable, None]) – Information about the specific audio to extract from the input.

Link

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.

Link

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.

Link

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.

Link

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
Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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

ColorSpacePassthroughSettingsProperty

class CfnChannel.ColorSpacePassthroughSettingsProperty

Bases: object

Passthrough applies no color space conversion to the output.

The parents of this entity are H264ColorSpaceSettings and H265ColorSpaceSettings.

Link

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

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.

Link

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

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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[InputLocationProperty, Dict[str, Any], IResolvable, 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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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

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.

Link

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.

Link

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.

Link

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

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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

Link

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.

Link

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

Link

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.

Link

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

The configuration of embedded captions in the output.

The parent of this entity is CaptionDestinationSettings.

Link

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

The settings for embedded plus SCTE-20 captions in the output.

The parent of this entity is CaptionDestinationSettings.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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, feature_activations=None, global_configuration=None, motion_graphics_configuration=None, nielsen_configuration=None, output_groups=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
Link

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

encoder_settings_property = medialive.CfnChannel.EncoderSettingsProperty(
    audio_descriptions=[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
                )
            )
        ),
        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(
                bitrate=123,
                bitstream_mode="bitstreamMode",
                coding_mode="codingMode",
                dialnorm=123,
                drc_profile="drcProfile",
                lfe_filter="lfeFilter",
                metadata_control="metadataControl"
            ),
            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"
    )],
    avail_blanking=medialive.CfnChannel.AvailBlankingProperty(
        avail_blanking_image=medialive.CfnChannel.InputLocationProperty(
            password_param="passwordParam",
            uri="uri",
            username="username"
        ),
        state="state"
    ),
    avail_configuration=medialive.CfnChannel.AvailConfigurationProperty(
        avail_settings=medialive.CfnChannel.AvailSettingsProperty(
            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"
            )
        )
    ),
    blackout_slate=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"
    ),
    caption_descriptions=[medialive.CfnChannel.CaptionDescriptionProperty(
        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"
    )],
    feature_activations=medialive.CfnChannel.FeatureActivationsProperty(
        input_prepare_schedule_actions="inputPrepareScheduleActions"
    ),
    global_configuration=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_timing_source="outputTimingSource",
        support_low_framerate_inputs="supportLowFramerateInputs"
    ),
    motion_graphics_configuration=medialive.CfnChannel.MotionGraphicsConfigurationProperty(
        motion_graphics_insertion="motionGraphicsInsertion",
        motion_graphics_settings=medialive.CfnChannel.MotionGraphicsSettingsProperty(
            html_motion_graphics_settings=medialive.CfnChannel.HtmlMotionGraphicsSettingsProperty()
        )
    ),
    nielsen_configuration=medialive.CfnChannel.NielsenConfigurationProperty(
        distributor_id="distributorId",
        nielsen_pcm_to_id3_tagging="nielsenPcmToId3Tagging"
    ),
    output_groups=[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",
                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",
                            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",
                                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",
                            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"
        )]
    )],
    timecode_config=medialive.CfnChannel.TimecodeConfigProperty(
        source="source",
        sync_threshold=123
    ),
    video_descriptions=[medialive.CfnChannel.VideoDescriptionProperty(
        codec_settings=medialive.CfnChannel.VideoCodecSettingsProperty(
            frame_capture_settings=medialive.CfnChannel.FrameCaptureSettingsProperty(
                capture_interval=123,
                capture_interval_units="captureIntervalUnits"
            ),
            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_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(),
                    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_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_insertion="timecodeInsertion"
            )
        ),
        height=123,
        name="name",
        respond_to_afd="respondToAfd",
        scaling_behavior="scalingBehavior",
        sharpness=123,
        width=123
    )]
)

Attributes

audio_descriptions

The encoding information for output audio.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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

feature_activations

Settings to enable specific features.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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

timecode_config

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

Link

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.

Link

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

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[FailoverConditionSettingsProperty, Dict[str, Any], IResolvable, None]) – Settings for a specific failover condition.

Link

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.

Link

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
Link

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.

Link

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.

Link

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.

Link

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)

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.

Link

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

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.

Link

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

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.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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 ‘,’.

Link

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.

Link

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.

Link

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[FrameCaptureS3SettingsProperty, Dict[str, Any], IResolvable, None]) – Sets up Amazon S3 as the destination for this Frame Capture output.

Link

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.

Link

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[OutputLocationRefProperty, Dict[str, Any], IResolvable, 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[FrameCaptureCdnSettingsProperty, Dict[str, Any], IResolvable, None]) – Settings to configure the destination of a Frame Capture output.

Link

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.

Link

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.

Link

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

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

The parent of this entity is HlsSettings.

Link

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 CfnChan