Local Participant
Types
Properties
The attributes set on this participant.
Changes can be observed by using io.livekit.android.util.flow
Changes can be observed by using io.livekit.android.util.flow
Changes can be observed by using io.livekit.android.util.flow
The participant's identity on the server. name should be preferred for UI usecases.
Changes can be observed by using io.livekit.android.util.flow
The kind of participant (i.e. a standard client participant, AI agent, etc.)
Timestamp when the participant last started speaking, in milliseconds
The metadata for this participant.
The participant's name. To be used for user-facing purposes (i.e. when displayed in the UI).
Changes can be observed by using io.livekit.android.util.flow
The permissions for this participant.
Maps track sids to their track publications.
Changes can be observed by using io.livekit.android.util.flow
Functions
Creates an audio track, recording audio through the microphone with the given options.
Creates a screencast video track.
Creates a video track, recording video through the camera with the given options.
Creates a video track, recording video through the supplied capturer.
Retrieves the first track that matches the source, or null
Retrieves the first track that matches name, or null
Publishes an audio track.
Publish a new data payload to the room. Data will be forwarded to each participant in the room. Each payload must not exceed 15k in size
Publishes an video track.
If set to enabled, creates and publishes a camera video track if not already done, and starts the camera.
If set to enabled, creates and publishes a microphone audio track if not already done, and unmutes the mic.
If set to enabled, creates and publishes a screenshare video track.
Control who can subscribe to LocalParticipant's published tracks.
Unpublish a track.
Set or update participant attributes. It will make updates only to keys that are present in attributes, and will not override others.
Updates the metadata of the local participant. Changes will not be reflected until the server responds confirming the update. Note: this requires CanUpdateOwnMetadata
permission encoded in the token.
Updates the name of the local participant. Changes will not be reflected until the server responds confirming the update. Note: this requires CanUpdateOwnMetadata
permission encoded in the token.