Participant

Object describing a participant that has joined a stage.

attributes

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.

Type: String to string map

Required: No

browserName

The participant’s browser.

Type: String

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

Pattern: [a-zA-Z0-9-_.,:;\s]*

Required: No

browserVersion

The participant’s browser version.

Type: String

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

Pattern: [a-zA-Z0-9-_.,:;\s]*

Required: No

firstJoinTime

ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.

Type: Timestamp

Required: No

ispName

The participant’s Internet Service Provider.

Type: String

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

Pattern: [a-zA-Z0-9-_.,:;\s]*

Required: No

osName

The participant’s operating system.

Type: String

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

Pattern: [a-zA-Z0-9-_.,:;\s]*

Required: No

osVersion

The participant’s operating system version.

Type: String

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

Pattern: [a-zA-Z0-9-_.,:;\s]*

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

protocol

Type of ingest protocol that the participant employs for broadcasting.

Type: String

Valid Values: UNKNOWN | WHIP | RTMP | RTMPS

Required: No

published

Whether the participant ever published to the stage session.

Type: Boolean

Required: No

recordingS3BucketName

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.

Type: String

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

Pattern: [a-z0-9-.]*

Required: No

recordingS3Prefix

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.

Type: String

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

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

Required: No

recordingState

The participant’s recording state.

Type: String

Required: No

sdkVersion

The participant’s SDK version.

Type: String

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

Pattern: [a-zA-Z0-9-_.,:;\s]*

Required: No

state

Whether the participant is connected to or disconnected from the stage.

Type: String

Valid Values: CONNECTED | DISCONNECTED

Required: 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

Participant

Contents

See Also