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.

protocol

var protocol: ParticipantProtocol?

Type of ingest protocol that the participant employs for broadcasting.

published

var published: Boolean

Whether the participant ever published to the stage session.

recordingS3BucketName

var recordingS3BucketName: String?

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.

recordingS3Prefix

var recordingS3Prefix: String?

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.

recordingState

var recordingState: ParticipantRecordingState?

The participant’s recording state.

replicationState

var replicationState: ReplicationState?

The participant's replication state.

replicationType

var replicationType: ReplicationType?

Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.

sdkVersion

var sdkVersion: String?

The participant’s SDK version.

sourceSessionId

var sourceSessionId: String?

ID of the session within the source stage, if replicationType is REPLICA.

sourceStageArn

var sourceStageArn: String?

Source stage ARN from which this participant is replicated, if replicationType is REPLICA.

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.