/AWS1/CL_IVSCHANNEL

Object specifying a channel.

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_ARN TYPE /AWS1/IVSCHANNELARN /AWS1/IVSCHANNELARN

Channel ARN.

IV_NAME TYPE /AWS1/IVSCHANNELNAME /AWS1/IVSCHANNELNAME

Channel name.

IV_LATENCYMODE TYPE /AWS1/IVSCHANNELLATENCYMODE /AWS1/IVSCHANNELLATENCYMODE

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.

IV_TYPE TYPE /AWS1/IVSCHANNELTYPE /AWS1/IVSCHANNELTYPE

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.

IV_RECORDINGCONFIGURATIONARN TYPE /AWS1/IVSCHANNELRECINGCONFARN /AWS1/IVSCHANNELRECINGCONFARN

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

IV_INGESTENDPOINT TYPE /AWS1/IVSINGESTENDPOINT /AWS1/IVSINGESTENDPOINT

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

IV_PLAYBACKURL TYPE /AWS1/IVSPLAYBACKURL /AWS1/IVSPLAYBACKURL

Channel playback URL.

IV_AUTHORIZED TYPE /AWS1/IVSISAUTHORIZED /AWS1/IVSISAUTHORIZED

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

IT_TAGS TYPE /AWS1/CL_IVSTAGS_W=>TT_TAGS TT_TAGS

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.

IV_INSECUREINGEST TYPE /AWS1/IVSINSECUREINGEST /AWS1/IVSINSECUREINGEST

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

IV_PRESET TYPE /AWS1/IVSTRANSCODEPRESET /AWS1/IVSTRANSCODEPRESET

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

IO_SRT TYPE REF TO /AWS1/CL_IVSSRT /AWS1/CL_IVSSRT

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

IV_PLAYBACKRESTRICTIONPLYARN TYPE /AWS1/IVSCHANNELPLAYBACKREST00 /AWS1/IVSCHANNELPLAYBACKREST00

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

IO_MULTITRACKINPUTCONF TYPE REF TO /AWS1/CL_IVSMULTITRACKINPCONF /AWS1/CL_IVSMULTITRACKINPCONF

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

IV_CONTAINERFORMAT TYPE /AWS1/IVSCONTAINERFORMAT /AWS1/IVSCONTAINERFORMAT

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.

---

Queryable Attributes

arn

Channel ARN.

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value

name

Channel name.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

latencyMode

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.

Accessible with the following methods

Method	Description
GET_LATENCYMODE()	Getter for LATENCYMODE, with configurable default
ASK_LATENCYMODE()	Getter for LATENCYMODE w/ exceptions if field has no value
HAS_LATENCYMODE()	Determine if LATENCYMODE has a value

type

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.

Accessible with the following methods

Method	Description
GET_TYPE()	Getter for TYPE, with configurable default
ASK_TYPE()	Getter for TYPE w/ exceptions if field has no value
HAS_TYPE()	Determine if TYPE has a value

recordingConfigurationArn

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

Accessible with the following methods

Method	Description
GET_RECORDINGCONFARN()	Getter for RECORDINGCONFIGURATIONARN, with configurable defa
ASK_RECORDINGCONFARN()	Getter for RECORDINGCONFIGURATIONARN w/ exceptions if field
HAS_RECORDINGCONFARN()	Determine if RECORDINGCONFIGURATIONARN has a value

ingestEndpoint

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

Accessible with the following methods

Method	Description
GET_INGESTENDPOINT()	Getter for INGESTENDPOINT, with configurable default
ASK_INGESTENDPOINT()	Getter for INGESTENDPOINT w/ exceptions if field has no valu
HAS_INGESTENDPOINT()	Determine if INGESTENDPOINT has a value

playbackUrl

Channel playback URL.

Accessible with the following methods

Method	Description
GET_PLAYBACKURL()	Getter for PLAYBACKURL, with configurable default
ASK_PLAYBACKURL()	Getter for PLAYBACKURL w/ exceptions if field has no value
HAS_PLAYBACKURL()	Determine if PLAYBACKURL has a value

authorized

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

Accessible with the following methods

Method	Description
GET_AUTHORIZED()	Getter for AUTHORIZED

tags

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.

Accessible with the following methods

Method	Description
GET_TAGS()	Getter for TAGS, with configurable default
ASK_TAGS()	Getter for TAGS w/ exceptions if field has no value
HAS_TAGS()	Determine if TAGS has a value

insecureIngest

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

Accessible with the following methods

Method	Description
GET_INSECUREINGEST()	Getter for INSECUREINGEST

preset

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

Accessible with the following methods

Method	Description
GET_PRESET()	Getter for PRESET, with configurable default
ASK_PRESET()	Getter for PRESET w/ exceptions if field has no value
HAS_PRESET()	Determine if PRESET has a value

srt

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

Accessible with the following methods

Method	Description
GET_SRT()	Getter for SRT

playbackRestrictionPolicyArn

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

Accessible with the following methods

Method	Description
GET_PLAYBACKRESTRICTIONPLY00()	Getter for PLAYBACKRESTRICTIONPOLICYARN, with configurable d
ASK_PLAYBACKRESTRICTIONPLY00()	Getter for PLAYBACKRESTRICTIONPOLICYARN w/ exceptions if fie
HAS_PLAYBACKRESTRICTIONPLY00()	Determine if PLAYBACKRESTRICTIONPOLICYARN has a value

multitrackInputConfiguration

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

Accessible with the following methods

Method	Description
GET_MULTITRACKINPUTCONF()	Getter for MULTITRACKINPUTCONFIGURATION

containerFormat

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.

Accessible with the following methods

Method	Description
GET_CONTAINERFORMAT()	Getter for CONTAINERFORMAT, with configurable default
ASK_CONTAINERFORMAT()	Getter for CONTAINERFORMAT w/ exceptions if field has no val
HAS_CONTAINERFORMAT()	Determine if CONTAINERFORMAT has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_CHANNELS

TYPES TT_CHANNELS TYPE STANDARD TABLE OF REF TO /AWS1/CL_IVSCHANNEL WITH DEFAULT KEY
.