ivsrealtime/aws.sdk.kotlin.services.ivsrealtime.model/Participant/Builder

Builder

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.

browserName

var browserName: String?

The participant’s browser.

browserVersion

var browserVersion: String?

The participant’s browser version.

firstJoinTime

var firstJoinTime: Instant?

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

ispName

var ispName: String?

The participant’s Internet Service Provider.

osName

var osName: String?

The participant’s operating system.

osVersion

var osVersion: String?

The participant’s operating system version.

participantId

var participantId: String?

Unique identifier for this participant, assigned by IVS.

published

var published: Boolean

Whether the participant ever published to the stage session.

sdkVersion

var sdkVersion: String?

The participant’s SDK version.

state

var state: ParticipantState?

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

userId

var userId: String?

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.