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.
INSUFFICIENT_CAPABILITIESindicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see thecapabilitiesfield in CreateParticipantToken.QUOTA_EXCEEDEDindicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas.PUBLISHER_NOT_FOUNDindicates that the participant tried to subscribe to a publisher that doesn’t exist.Type: String
Valid Values:
INSUFFICIENT_CAPABILITIES | QUOTA_EXCEEDED | PUBLISHER_NOT_FOUNDRequired: 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_ERRORRequired: 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:
