Channel
Object specifying a channel.
Contents
- arn
-
Channel ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$
Required: No
- authorized
-
Whether the channel is authorized. Default:
false
.Type: Boolean
Required: No
- ingestEndpoint
-
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
Type: String
Required: No
- latencyMode
-
Channel latency mode. Use
NORMAL
to broadcast and deliver live video up to Full HD. UseLOW
for near-real-time interaction with viewers. Default:LOW
. (Note: In the Amazon IVS console,LOW
andNORMAL
correspond to Ultra-low and Standard, respectively.)Type: String
Valid Values:
NORMAL | LOW
Required: No
- name
-
Channel name.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern:
^[a-zA-Z0-9-_]*$
Required: No
- playbackUrl
-
Channel playback URL.
Type: String
Required: No
- tags
-
Array of 1-50 maps, each of the form
string:string (key:value)
.Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Maximum length of 256.
Required: No
- type
-
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default:
STANDARD
. Valid values:-
STANDARD
: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps. -
BASIC
: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
Type: String
Valid Values:
BASIC | STANDARD
Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: