Skip to content

/AWS1/CL_IVREVENT

An occurrence during a stage session.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_name TYPE /AWS1/IVREVENTNAME /AWS1/IVREVENTNAME

The name of the event.

iv_participantid TYPE /AWS1/IVRPARTICIPANTID /AWS1/IVRPARTICIPANTID

Unique identifier for the participant who triggered the event. This is assigned by IVS.

iv_eventtime TYPE /AWS1/IVRTIME /AWS1/IVRTIME

ISO 8601 timestamp (returned as a string) for when the event occurred.

iv_remoteparticipantid TYPE /AWS1/IVRPARTICIPANTID /AWS1/IVRPARTICIPANTID

Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.

iv_errorcode TYPE /AWS1/IVREVENTERRORCODE /AWS1/IVREVENTERRORCODE

If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null.

  • B_FRAME_PRESENT — The participant's stream includes B-frames. For details, see IVS RTMP Publishing.

  • BITRATE_EXCEEDED — The participant exceeded the maximum supported bitrate. For details, see Service Quotas.

  • INSUFFICIENT_CAPABILITIES — The participant tried to take an action that the participant’s token is not allowed to do. For details on participant capabilities, see the capabilities field in CreateParticipantToken.

  • INTERNAL_SERVER_EXCEPTION — The participant failed to publish to the stage due to an internal server error.

  • INVALID_AUDIO_CODEC — The participant is using an invalid audio codec. For details, see Stream Ingest.

  • INVALID_INPUT — The participant is using an invalid input stream.

  • INVALID_PROTOCOL — The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP. For details, see IVS RTMP Publishing.

  • INVALID_STREAM_KEY — The participant is using an invalid stream key. For details, see IVS RTMP Publishing.

  • INVALID_VIDEO_CODEC — The participant is using an invalid video codec. For details, see Stream Ingest.

  • PUBLISHER_NOT_FOUND — The participant tried to subscribe to a publisher that doesn’t exist.

  • QUOTA_EXCEEDED — The number of participants who want to publish/subscribe to a stage exceeds the quota. For details, see Service Quotas.

  • RESOLUTION_EXCEEDED — The participant exceeded the maximum supported resolution. For details, see Service Quotas.

  • REUSE_OF_STREAM_KEY — The participant tried to use a stream key that is associated with another active stage session.

  • STREAM_DURATION_EXCEEDED — The participant exceeded the maximum allowed stream duration. For details, see Service Quotas.

iv_destinationstagearn TYPE /AWS1/IVRSTAGEARN /AWS1/IVRSTAGEARN

ARN of the stage where the participant is replicated. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.

iv_destinationsessionid TYPE /AWS1/IVRSTAGESESSIONID /AWS1/IVRSTAGESESSIONID

ID of the session within the destination stage. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.

iv_replica TYPE /AWS1/IVRREPLICA /AWS1/IVRREPLICA

If true, this indicates the participantId is a replicated participant. If this is a subscribe event, then this flag refers to remoteParticipantId.

Queryable Attributes

name

The name of the event.

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

participantId

Unique identifier for the participant who triggered the event. This is assigned by IVS.

Accessible with the following methods

Method Description
GET_PARTICIPANTID() Getter for PARTICIPANTID, with configurable default
ASK_PARTICIPANTID() Getter for PARTICIPANTID w/ exceptions if field has no value
HAS_PARTICIPANTID() Determine if PARTICIPANTID has a value

eventTime

ISO 8601 timestamp (returned as a string) for when the event occurred.

Accessible with the following methods

Method Description
GET_EVENTTIME() Getter for EVENTTIME, with configurable default
ASK_EVENTTIME() Getter for EVENTTIME w/ exceptions if field has no value
HAS_EVENTTIME() Determine if EVENTTIME has a value

remoteParticipantId

Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.

Accessible with the following methods

Method Description
GET_REMOTEPARTICIPANTID() Getter for REMOTEPARTICIPANTID, with configurable default
ASK_REMOTEPARTICIPANTID() Getter for REMOTEPARTICIPANTID w/ exceptions if field has no
HAS_REMOTEPARTICIPANTID() Determine if REMOTEPARTICIPANTID has a value

errorCode

If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null.

  • B_FRAME_PRESENT — The participant's stream includes B-frames. For details, see IVS RTMP Publishing.

  • BITRATE_EXCEEDED — The participant exceeded the maximum supported bitrate. For details, see Service Quotas.

  • INSUFFICIENT_CAPABILITIES — The participant tried to take an action that the participant’s token is not allowed to do. For details on participant capabilities, see the capabilities field in CreateParticipantToken.

  • INTERNAL_SERVER_EXCEPTION — The participant failed to publish to the stage due to an internal server error.

  • INVALID_AUDIO_CODEC — The participant is using an invalid audio codec. For details, see Stream Ingest.

  • INVALID_INPUT — The participant is using an invalid input stream.

  • INVALID_PROTOCOL — The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP. For details, see IVS RTMP Publishing.

  • INVALID_STREAM_KEY — The participant is using an invalid stream key. For details, see IVS RTMP Publishing.

  • INVALID_VIDEO_CODEC — The participant is using an invalid video codec. For details, see Stream Ingest.

  • PUBLISHER_NOT_FOUND — The participant tried to subscribe to a publisher that doesn’t exist.

  • QUOTA_EXCEEDED — The number of participants who want to publish/subscribe to a stage exceeds the quota. For details, see Service Quotas.

  • RESOLUTION_EXCEEDED — The participant exceeded the maximum supported resolution. For details, see Service Quotas.

  • REUSE_OF_STREAM_KEY — The participant tried to use a stream key that is associated with another active stage session.

  • STREAM_DURATION_EXCEEDED — The participant exceeded the maximum allowed stream duration. For details, see Service Quotas.

Accessible with the following methods

Method Description
GET_ERRORCODE() Getter for ERRORCODE, with configurable default
ASK_ERRORCODE() Getter for ERRORCODE w/ exceptions if field has no value
HAS_ERRORCODE() Determine if ERRORCODE has a value

destinationStageArn

ARN of the stage where the participant is replicated. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.

Accessible with the following methods

Method Description
GET_DESTINATIONSTAGEARN() Getter for DESTINATIONSTAGEARN, with configurable default
ASK_DESTINATIONSTAGEARN() Getter for DESTINATIONSTAGEARN w/ exceptions if field has no
HAS_DESTINATIONSTAGEARN() Determine if DESTINATIONSTAGEARN has a value

destinationSessionId

ID of the session within the destination stage. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.

Accessible with the following methods

Method Description
GET_DESTINATIONSESSIONID() Getter for DESTINATIONSESSIONID, with configurable default
ASK_DESTINATIONSESSIONID() Getter for DESTINATIONSESSIONID w/ exceptions if field has n
HAS_DESTINATIONSESSIONID() Determine if DESTINATIONSESSIONID has a value

replica

If true, this indicates the participantId is a replicated participant. If this is a subscribe event, then this flag refers to remoteParticipantId.

Accessible with the following methods

Method Description
GET_REPLICA() Getter for REPLICA

Public Local Types In This Class

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

TT_EVENTLIST

TYPES TT_EVENTLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_IVREVENT WITH DEFAULT KEY
.