/AWS1/CL_IVSSTREAMSUMMARY¶
Summary information about a stream.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_channelarn TYPE /AWS1/IVSCHANNELARN /AWS1/IVSCHANNELARN¶
Channel ARN for the stream.
iv_streamid TYPE /AWS1/IVSSTREAMID /AWS1/IVSSTREAMID¶
Unique identifier for a live or previously live stream in the specified channel.
iv_state TYPE /AWS1/IVSSTREAMSTATE /AWS1/IVSSTREAMSTATE¶
The stream’s state. Do not rely on the
OFFLINEstate, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
iv_health TYPE /AWS1/IVSSTREAMHEALTH /AWS1/IVSSTREAMHEALTH¶
The stream’s health.
iv_viewercount TYPE /AWS1/IVSSTREAMVIEWERCOUNT /AWS1/IVSSTREAMVIEWERCOUNT¶
A count of concurrent views of the stream. Typically, a new view appears in
viewerCountwithin 15 seconds of when video playback starts and a view is removed fromviewerCountwithin 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
iv_starttime TYPE /AWS1/IVSSTREAMSTARTTIME /AWS1/IVSSTREAMSTARTTIME¶
Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
Queryable Attributes¶
channelArn¶
Channel ARN for the stream.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHANNELARN() |
Getter for CHANNELARN, with configurable default |
ASK_CHANNELARN() |
Getter for CHANNELARN w/ exceptions if field has no value |
HAS_CHANNELARN() |
Determine if CHANNELARN has a value |
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 |
state¶
The stream’s state. Do not rely on the
OFFLINEstate, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATE() |
Getter for STATE, with configurable default |
ASK_STATE() |
Getter for STATE w/ exceptions if field has no value |
HAS_STATE() |
Determine if STATE has a value |
health¶
The stream’s health.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HEALTH() |
Getter for HEALTH, with configurable default |
ASK_HEALTH() |
Getter for HEALTH w/ exceptions if field has no value |
HAS_HEALTH() |
Determine if HEALTH has a value |
viewerCount¶
A count of concurrent views of the stream. Typically, a new view appears in
viewerCountwithin 15 seconds of when video playback starts and a view is removed fromviewerCountwithin 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VIEWERCOUNT() |
Getter for VIEWERCOUNT |
startTime¶
Time of the stream’s start. 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 |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_STREAMLIST¶
TYPES TT_STREAMLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_IVSSTREAMSUMMARY WITH DEFAULT KEY
.