ParticipantSummary
Summary object describing a participant that has joined a stage.
Contents
- firstJoinTime
-
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
Type: Timestamp
Required: No
- participantId
-
Unique identifier for this participant, assigned by IVS.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern:
[a-zA-Z0-9-]*Required: No
- published
-
Whether the participant ever published to the stage session.
Type: Boolean
Required: No
- recordingState
-
The participant’s recording state.
Type: String
Valid Values:
STARTING | ACTIVE | STOPPING | STOPPED | FAILED | DISABLEDRequired: No
- state
-
Whether the participant is connected to or disconnected from the stage.
Type: String
Valid Values:
CONNECTED | DISCONNECTEDRequired: No
- userId
-
Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
