Channel ¶

class Channel(TypedDict, closed=True):
    arn: NotRequired["capo_ivs.types.channel_arn.ChannelArn"]
    """<p>Channel ARN.</p>"""
    name: NotRequired["capo_ivs.types.channel_name.ChannelName"]
    """<p>Channel name.</p>"""
    latency_mode: NotRequired["capo_ivs.types.channel_latency_mode.ChannelLatencyMode"]
    """<p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. Default: <code>LOW</code>.</p>"""
    type: NotRequired["capo_ivs.types.channel_type.ChannelType"]
    """<p>Channel type, which determines the allowable resolution and bitrate. <i>If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately.</i> Default: <code>STANDARD</code>. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/channel-types.html">Channel Types</a>.</p>"""
    recording_configuration_arn: NotRequired[
        "capo_ivs.types.channel_recording_configuration_arn.ChannelRecordingConfigurationArn"
    ]
    """<p>Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).</p>"""
    ingest_endpoint: NotRequired["capo_ivs.types.ingest_endpoint.IngestEndpoint"]
    """<p>Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.</p>"""
    playback_url: NotRequired["capo_ivs.types.playback_url.PlaybackURL"]
    """<p>Channel playback URL.</p>"""
    authorized: "capo_ivs.types.is_authorized.IsAuthorized"
    """<p>Whether the channel is private (enabled for playback authorization). Default: <code>false</code>.</p>"""
    tags: NotRequired["capo_ivs.types.tags.Tags"]
    """<p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.</p>"""
    insecure_ingest: "capo_ivs.types.insecure_ingest.InsecureIngest"
    """<p>Whether the channel allows insecure RTMP ingest. Default: <code>false</code>.</p>"""
    preset: NotRequired["capo_ivs.types.transcode_preset.TranscodePreset"]
    """<p>Optional transcode preset for the channel. This is selectable only for <code>ADVANCED_HD</code> and <code>ADVANCED_SD</code> channel types. For those channel types, the default <code>preset</code> is <code>HIGHER_BANDWIDTH_DELIVERY</code>. For other channel types (<code>BASIC</code> and <code>STANDARD</code>), <code>preset</code> is the empty string (<code>""</code>).</p>"""
    srt: NotRequired["capo_ivs.types.srt.Srt"]
    """<p>Specifies the endpoint and optional passphrase for streaming with the SRT protocol.</p>"""
    playback_restriction_policy_arn: NotRequired[
        "capo_ivs.types.channel_playback_restriction_policy_arn.ChannelPlaybackRestrictionPolicyArn"
    ]
    """<p>Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).</p>"""
    multitrack_input_configuration: NotRequired[
        "capo_ivs.types.multitrack_input_configuration.MultitrackInputConfiguration"
    ]
    """<p>Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.</p>"""
    container_format: NotRequired["capo_ivs.types.container_format.ContainerFormat"]
    """<p>Indicates which content-packaging format is used (MPEG-TS or fMP4). If <code>multitrackInputConfiguration</code> is specified and <code>enabled</code> is <code>true</code>, then <code>containerFormat</code> is required and must be set to <code>FRAGMENTED_MP4</code>. Otherwise, <code>containerFormat</code> may be set to <code>TS</code> or <code>FRAGMENTED_MP4</code>. Default: <code>TS</code>.</p>"""
    ad_configuration_arn: NotRequired[
        "capo_ivs.types.channel_ad_configuration_arn.ChannelAdConfigurationArn"
    ]
    """<p>ARN of the ad configuration associated with the channel.</p>"""