LocalParticipant

class LocalParticipant : Participant

A class that contains all operational methods of a local participant to handle their audio and video.

Since

1.6.0

Functions

fetchBluetoothDevices
Link copied to clipboard
fun fetchBluetoothDevices()
muteMicrophone
Link copied to clipboard
fun muteMicrophone()

Mutes the local user's audio.

resumeVideoCapturer
Link copied to clipboard
fun resumeVideoCapturer()

Connects the device camera and Sendbird Calls SDK to stream video for local participant.

startVideo
Link copied to clipboard
fun startVideo()

Starts the local user's video.

stopVideo
Link copied to clipboard
fun stopVideo()

Stops the local user's video.

switchCamera
Link copied to clipboard
fun switchCamera(handler: CompletionHandler?)

Switches the local user's front and back cameras.

unmuteMicrophone
Link copied to clipboard
fun unmuteMicrophone()

Unmutes the local user's audio

Properties

duration
Link copied to clipboard
var duration: Long?

The period from the time when the participant entered the room to the time the participant left the room, measured in seconds.

enteredAt
Link copied to clipboard
val enteredAt: Long

The timestamp of when the participant enter the room, in Unix milliseconds.

exitedAt
Link copied to clipboard
var exitedAt: Long?

The timestamp of when the participant exited the room, in Unix milliseconds.

isAudioEnabled
Link copied to clipboard
var isAudioEnabled: Boolean

Indicates whether the participant has enabled their audio.

isVideoEnabled
Link copied to clipboard
var isVideoEnabled: Boolean

Indicates whether the participant has enabled their video.

participantId
Link copied to clipboard
val participantId: String

A unique identifier for a participant in a room.

state
Link copied to clipboard
var state: ParticipantState

The state of the participant. Valid values are ParticipantState.ENTERED, ParticipantState.EXITED, and ParticipantState.CONNECTED.

updatedAt
Link copied to clipboard
var updatedAt: Long

The timestamp of when the participant information was updated within the room, in Unix milliseconds.

user
Link copied to clipboard
var user: User

Indicates a user in Calls who corresponds to the participant.

videoView
Link copied to clipboard
open override var videoView: SendBirdVideoView? = null

Sets the participant's video view.