livekit-compose-components/io.livekit.android.compose.local

Package-level declarations

Composition locals to aid in development of Livekit features.

Properties

Link copied to clipboard
val ParticipantLocal: ProvidableCompositionLocal<Participant>

CompositionLocal for the Participant currently provided by ParticipantScope

Link copied to clipboard
val RoomLocal: ProvidableCompositionLocal<Room>

CompositionLocal for the Room currently provided by RoomScope

Link copied to clipboard
val SessionLocal: ProvidableCompositionLocal<Session>

Not to be confused with LocalParticipant.

Link copied to clipboard

Functions

Link copied to clipboard
@Composable
fun ForEachParticipant(participants: List<Participant>, content: @Composable (Participant) -> Unit)

A simple way to loop over participants that creates a ParticipantScope for each participant and calls content.

Link copied to clipboard
@Composable
fun ForEachTrack(tracks: List<TrackReference>, content: @Composable (TrackReference) -> Unit)

A simple way to loop over tracks that creates a TrackReferenceScope for each track and calls content.

Link copied to clipboard
@Composable
fun HandleRoomState(state: Room.State, passedRoom: Room? = null, vararg keys: Any, onState: suspend CoroutineScope.(Room, Room.State) -> Unit?)

@Composable
fun HandleRoomState(states: List<Room.State> = emptyList(), passedRoom: Room? = null, vararg keys: Any, onState: suspend CoroutineScope.(Room, Room.State) -> Unit?)

A simple handler for listening to room state changes.

Link copied to clipboard
@Composable
fun ParticipantScope(participant: Participant, content: @Composable () -> Unit)
Link copied to clipboard
@Composable
fun rememberLiveKitRoom(url: String? = null, token: String? = null, audio: Boolean = false, video: Boolean = false, connect: Boolean = true, roomOptions: RoomOptions? = null, liveKitOverrides: LiveKitOverrides? = null, connectOptions: ConnectOptions? = null, onConnected: suspend CoroutineScope.(Room) -> Unit? = null, onDisconnected: suspend CoroutineScope.(Room) -> Unit? = null, onError: (Room, Exception?) -> Unit? = DEFAULT_ERROR_HANDLER, passedRoom: Room? = null, disconnectOnDispose: Boolean = true): Room

Remembers a new Room object.

Link copied to clipboard
@Composable
fun requireParticipant(passedParticipant: Participant? = null): Participant

Returns the passedParticipant or the currently provided ParticipantLocal.

Link copied to clipboard
@Composable
fun requireRoom(passedRoom: Room? = null): Room

Returns the passedRoom or the currently provided RoomLocal.

Link copied to clipboard
@Composable
fun requireSession(session: Session? = null): Session

Returns the session, or if null/no-arg, the currently provided SessionLocal.

Link copied to clipboard
@Composable
fun requireTrack(passedTrack: TrackReference? = null): TrackReference

Returns the passedTrack or the currently provided TrackReferenceLocal.

Link copied to clipboard
@Composable
fun RoomScope(url: String? = null, token: String? = null, audio: Boolean = false, video: Boolean = false, connect: Boolean = true, roomOptions: RoomOptions? = null, liveKitOverrides: LiveKitOverrides? = null, connectOptions: ConnectOptions? = null, onConnected: suspend CoroutineScope.(Room) -> Unit? = null, onDisconnected: suspend CoroutineScope.(Room) -> Unit? = null, onError: (Room, Exception?) -> Unit? = null, passedRoom: Room? = null, disconnectOnDispose: Boolean = true, content: @Composable (room: Room) -> Unit)

Establishes a room scope which remembers a Room object which can be accessed through the RoomLocal composition local.

Link copied to clipboard
@Composable
fun SessionScope(session: Session, content: @Composable (session: Session) -> Unit)

Establishes a session scope which allows the current Session that can be accessed through the SessionLocal composition local, as well as the session's room object through the RoomLocal composition local.

Link copied to clipboard
@Composable
fun TrackReferenceScope(trackRef: TrackReference, content: @Composable () -> Unit)

Binds trackRef to the TrackReferenceLocal for the scope of content.