Channel

class Channel

Object specifying a channel.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String?

Channel ARN.

Link copied to clipboard

Whether the channel is private (enabled for playback authorization). Default: false.

Link copied to clipboard

Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.

Link copied to clipboard

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

Link copied to clipboard

Whether the channel allows insecure RTMP ingest. Default: false.

Link copied to clipboard

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.

Link copied to clipboard

Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.

Link copied to clipboard
val name: String?

Channel name.

Link copied to clipboard

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

Link copied to clipboard

Channel playback URL.

Link copied to clipboard

Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

Link copied to clipboard

Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).

Link copied to clipboard
val srt: Srt?

Specifies the endpoint and optional passphrase for streaming with the SRT protocol.

Link copied to clipboard

Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor 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.

Link copied to clipboard

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

Functions

Link copied to clipboard
inline fun copy(block: Channel.Builder.() -> Unit = {}): Channel
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String