fun createScreencastTrack(name: String = "", mediaProjectionPermissionResultData: Intent, options: LocalVideoTrackOptions = screenShareTrackCaptureDefaults.copy(), videoProcessor: VideoProcessor? = null): LocalScreencastVideoTrack

Creates a screencast video track.

createVideoTrack

fun createVideoTrack(name: String = "", options: LocalVideoTrackOptions = videoTrackCaptureDefaults.copy(), videoProcessor: VideoProcessor? = null): LocalVideoTrack

Creates a video track, recording video through the camera with the given options.

fun createVideoTrack(name: String = "", capturer: VideoCapturer, options: LocalVideoTrackOptions = videoTrackCaptureDefaults.copy(), videoProcessor: VideoProcessor? = null): LocalVideoTrack

Creates a video track, recording video through the supplied capturer.

equals

open operator override fun equals(other: Any?): Boolean

getTrackPublication

open override fun getTrackPublication(source: Track.Source): LocalTrackPublication?

Retrieves the first track that matches the source, or null

getTrackPublicationByName

open override fun getTrackPublicationByName(name: String): LocalTrackPublication?

Retrieves the first track that matches name, or null

hashCode

open override fun hashCode(): Int

isCameraEnabled

fun isCameraEnabled(): Boolean

isMicrophoneEnabled

fun isMicrophoneEnabled(): Boolean

isScreenShareEnabled

fun isScreenShareEnabled(): Boolean

performRpc

suspend fun performRpc(destinationIdentity: Participant.Identity, method: String, payload: String, responseTimeout: Duration = 10.seconds): String

Initiate an RPC call to a remote participant

publishAudioTrack

suspend fun publishAudioTrack(track: LocalAudioTrack, options: AudioTrackPublishOptions = AudioTrackPublishOptions( null, audioTrackPublishDefaults, ), publishListener: LocalParticipant.PublishListener? = null)

Publishes an audio track.

publishData

suspend fun publishData(data: ByteArray, reliability: DataPublishReliability = DataPublishReliability.RELIABLE, topic: String? = null, identities: List<Participant.Identity>? = null)

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

publishDtmf

suspend fun publishDtmf(code: Int, digit: String)

This suspend function allows you to publish DTMF (Dual-Tone Multi-Frequency) signals within a LiveKit room. The publishDtmf function constructs a SipDTMF message using the provided code and digit, then encapsulates it in a DataPacket before sending it via the engine.

publishVideoTrack

suspend fun publishVideoTrack(track: LocalVideoTrack, options: VideoTrackPublishOptions = VideoTrackPublishOptions(null, videoTrackPublishDefaults), publishListener: LocalParticipant.PublishListener? = null)

Publishes an video track.

registerRpcMethod

suspend fun registerRpcMethod(method: String, handler: RpcHandler)

Establishes the participant as a receiver for calls of the specified RPC method. Will overwrite any existing callback for the same method.

setCameraEnabled

suspend fun setCameraEnabled(enabled: Boolean)

If set to enabled, creates and publishes a camera video track if not already done, and starts the camera.

setMicrophoneEnabled

suspend fun setMicrophoneEnabled(enabled: Boolean)

If set to enabled, creates and publishes a microphone audio track if not already done, and unmutes the mic.

setScreenShareEnabled

suspend fun setScreenShareEnabled(enabled: Boolean, mediaProjectionPermissionResultData: Intent? = null)

If set to enabled, creates and publishes a screenshare video track.

setTrackSubscriptionPermissions

fun setTrackSubscriptionPermissions(allParticipantsAllowed: Boolean, participantTrackPermissions: List<ParticipantTrackPermission> = emptyList())

Control who can subscribe to LocalParticipant's published tracks.

unpublishTrack

fun unpublishTrack(track: Track, stopOnUnpublish: Boolean = true)

Unpublish a track.

unregisterRpcMethod

fun unregisterRpcMethod(method: String)

Unregisters a previously registered RPC method.

updateAttributes

fun updateAttributes(attributes: Map<String, String>)

Set or update participant attributes. It will make updates only to keys that are present in attributes, and will not override others.

updateMetadata

fun updateMetadata(metadata: String)

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.

updateName

fun updateName(name: String)

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.