Skip to content

/AWS1/CL_IVSSTREAMSESSION

Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_streamid TYPE /AWS1/IVSSTREAMID /AWS1/IVSSTREAMID

Unique identifier for a live or previously live stream in the specified channel.

iv_starttime TYPE /AWS1/IVSTIME /AWS1/IVSTIME

Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

iv_endtime TYPE /AWS1/IVSTIME /AWS1/IVSTIME

Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.

io_channel TYPE REF TO /AWS1/CL_IVSCHANNEL /AWS1/CL_IVSCHANNEL

The properties of the channel at the time of going live.

io_ingestconfiguration TYPE REF TO /AWS1/CL_IVSINGESTCONF /AWS1/CL_IVSINGESTCONF

The properties of the incoming RTMP stream.

Note: ingestConfiguration is deprecated in favor of ingestConfigurations but retained to ensure backward compatibility. If multitrack is not enabled, ingestConfiguration and ingestConfigurations contain the same data, namely information about track0 (the sole track). If multitrack is enabled, ingestConfiguration contains data for only the first track (track0) and ingestConfigurations contains data for all tracks.

io_ingestconfigurations TYPE REF TO /AWS1/CL_IVSINGESTCONFS /AWS1/CL_IVSINGESTCONFS

The properties of the incoming RTMP stream. If multitrack is enabled, ingestConfigurations contains data for all tracks; otherwise, it contains data only for track0 (the sole track).

io_recordingconfiguration TYPE REF TO /AWS1/CL_IVSRECORDINGCONF /AWS1/CL_IVSRECORDINGCONF

The properties of recording the live stream.

it_truncatedevents TYPE /AWS1/CL_IVSSTREAMEVENT=>TT_STREAMEVENTS TT_STREAMEVENTS

List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.

Queryable Attributes

streamId

Unique identifier for a live or previously live stream in the specified channel.

Accessible with the following methods

Method Description
GET_STREAMID() Getter for STREAMID, with configurable default
ASK_STREAMID() Getter for STREAMID w/ exceptions if field has no value
HAS_STREAMID() Determine if STREAMID has a value

startTime

Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

Accessible with the following methods

Method Description
GET_STARTTIME() Getter for STARTTIME, with configurable default
ASK_STARTTIME() Getter for STARTTIME w/ exceptions if field has no value
HAS_STARTTIME() Determine if STARTTIME has a value

endTime

Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.

Accessible with the following methods

Method Description
GET_ENDTIME() Getter for ENDTIME, with configurable default
ASK_ENDTIME() Getter for ENDTIME w/ exceptions if field has no value
HAS_ENDTIME() Determine if ENDTIME has a value

channel

The properties of the channel at the time of going live.

Accessible with the following methods

Method Description
GET_CHANNEL() Getter for CHANNEL

ingestConfiguration

The properties of the incoming RTMP stream.

Note: ingestConfiguration is deprecated in favor of ingestConfigurations but retained to ensure backward compatibility. If multitrack is not enabled, ingestConfiguration and ingestConfigurations contain the same data, namely information about track0 (the sole track). If multitrack is enabled, ingestConfiguration contains data for only the first track (track0) and ingestConfigurations contains data for all tracks.

Accessible with the following methods

Method Description
GET_INGESTCONFIGURATION() Getter for INGESTCONFIGURATION

ingestConfigurations

The properties of the incoming RTMP stream. If multitrack is enabled, ingestConfigurations contains data for all tracks; otherwise, it contains data only for track0 (the sole track).

Accessible with the following methods

Method Description
GET_INGESTCONFIGURATIONS() Getter for INGESTCONFIGURATIONS

recordingConfiguration

The properties of recording the live stream.

Accessible with the following methods

Method Description
GET_RECORDINGCONFIGURATION() Getter for RECORDINGCONFIGURATION

truncatedEvents

List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.

Accessible with the following methods

Method Description
GET_TRUNCATEDEVENTS() Getter for TRUNCATEDEVENTS, with configurable default
ASK_TRUNCATEDEVENTS() Getter for TRUNCATEDEVENTS w/ exceptions if field has no val
HAS_TRUNCATEDEVENTS() Determine if TRUNCATEDEVENTS has a value