Participant
Object describing a participant that has joined a stage.
Types
Properties
Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
The participant’s browser.
The participant’s browser version.
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
Unique identifier for this participant, assigned by IVS.
Type of ingest protocol that the participant employs for broadcasting.
Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.
S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled. If individual participant recording merge is enabled, and if a stage publisher disconnects from a stage and then reconnects, IVS tries to record to the same S3 prefix as the previous session. See /ivs/latest/RealTimeUserGuide/rt-individual-participant-recording.html#ind-part-rec-merge-frag.
The participant’s recording state.
The participant's replication state.
Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.
The participant’s SDK version.
ID of the session within the source stage, if replicationType is REPLICA.
Source stage ARN from which this participant is replicated, if replicationType is REPLICA.
Whether the participant is connected to or disconnected from the stage.
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.