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

Package-level declarations

State functions for room/participants to use within composables.

Types

Link copied to clipboard
@Immutable
data class ParticipantInfo(val name: String?, val identity: Participant.Identity?, val metadata: String?)

Holder for basic Participant information.

Link copied to clipboard
@Immutable
data class RoomInfo(val name: String?, val metadata: String?)

Holder for basic Room information.

Functions

Link copied to clipboard
fun Room.getTrackReferences(sources: List<Track.Source>, usePlaceholders: Set<Track.Source> = emptySet(), onlySubscribed: Boolean = true): List<TrackReference>
Link copied to clipboard
fun Participant.getTrackReferencesBySource(sources: List<Track.Source>, usePlaceholders: Set<Track.Source> = emptySet(), onlySubscribed: Boolean = true): List<TrackReference>
Link copied to clipboard
@Composable
fun rememberParticipantInfo(passedParticipant: Participant? = null): ParticipantInfo

Remembers the participant info and updates whenever it is changed.

Link copied to clipboard
@Composable
fun rememberParticipants(passedRoom: Room? = null): List<Participant>

Remembers the full list of participants, with the local participant included as the first item in the list.

Link copied to clipboard
@Composable
fun rememberParticipantTrackReferences(sources: List<Track.Source> = listOf( Track.Source.CAMERA, Track.Source.SCREEN_SHARE ), usePlaceholders: Set<Track.Source> = emptySet(), passedParticipant: Participant? = null, onlySubscribed: Boolean = true): List<TrackReference>
@Composable
fun rememberParticipantTrackReferences(sources: List<Track.Source>, participantIdentity: Participant.Identity, passedRoom: Room? = null, usePlaceholders: Set<Track.Source> = emptySet(), onlySubscribed: Boolean = true): List<TrackReference>

Returns an array of TrackReferences for a participant depending the sources provided.

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

Remembers the room info and updates whenever it is changed.

Link copied to clipboard
@Composable
fun <T : Track> rememberTrack(trackIdentifier: TrackIdentifier): T?

Observes the trackIdentifier object for the track.

Link copied to clipboard
Link copied to clipboard
@Composable
fun rememberTracks(sources: List<Track.Source> = listOf( Track.Source.CAMERA, Track.Source.SCREEN_SHARE ), usePlaceholders: Set<Track.Source> = emptySet(), passedRoom: Room? = null, onlySubscribed: Boolean = true): List<TrackReference>

Returns an array of TrackReferences depending the sources provided.