CreateChannelRequest
¶
Source code in docs_src/capo_mediapackagev2/types/create_channel_request.py
channel_group_name
instance-attribute
¶
channel_group_name: ResourceName
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name
instance-attribute
¶
channel_name: ResourceName
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.
client_token
instance-attribute
¶
client_token: NotRequired[IdempotencyToken]
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
description
instance-attribute
¶
description: NotRequired[ResourceDescription]
Enter any descriptive text that helps you to identify the channel.
input_switch_configuration
instance-attribute
¶
input_switch_configuration: NotRequired[InputSwitchConfiguration]
The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when InputType is CMAF.
input_type
instance-attribute
¶
input_type: NotRequired[InputType]
The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.
The allowed values are:
-
HLS- The HLS streaming specification (which defines M3U8 manifests and TS segments). -
CMAF- The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests). -
MULTIVIEW– Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in itsMultiviewConfigurationinto a single tiled output stream.
multiview_configuration
instance-attribute
¶
multiview_configuration: NotRequired[MultiviewConfiguration]
The multiview configuration for the channel. This setting is required when InputType is MULTIVIEW, and can't be set for any other input type.
output_header_configuration
instance-attribute
¶
output_header_configuration: NotRequired[OutputHeaderConfiguration]
The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF.
output_locking_mode
instance-attribute
¶
output_locking_mode: NotRequired[OutputLockingMode]
The output locking mode for the channel. This setting is only valid when InputType is CMAF. This value is immutable after channel creation. If you don't specify a value, the default is EPOCH_LOCKED.
The allowed values are:
-
EPOCH_LOCKED- The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time. This mode supports cross-region synchronization and failover. -
NON_EPOCH_LOCKED- The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0. This mode does not support cross-region synchronization or failover.