Event - Amazon IVS
ContentsSee Also

Event

An occurrence during a stage session.

Contents

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.

Type: String

Valid Values: INSUFFICIENT_CAPABILITIES | QUOTA_EXCEEDED | PUBLISHER_NOT_FOUND | BITRATE_EXCEEDED | RESOLUTION_EXCEEDED | STREAM_DURATION_EXCEEDED | INVALID_AUDIO_CODEC | INVALID_VIDEO_CODEC | INVALID_PROTOCOL | INVALID_STREAM_KEY | REUSE_OF_STREAM_KEY | B_FRAME_PRESENT | INVALID_INPUT | INTERNAL_SERVER_EXCEPTION

Required: No

eventTime

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

Type: Timestamp

Required: No

name

The name of the event.

Type: String

Valid Values: JOINED | LEFT | PUBLISH_STARTED | PUBLISH_STOPPED | SUBSCRIBE_STARTED | SUBSCRIBE_STOPPED | PUBLISH_ERROR | SUBSCRIBE_ERROR | JOIN_ERROR

Required: No

participantId

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: [a-zA-Z0-9-]*

Required: No

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: [a-zA-Z0-9-]*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: