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

Package-level declarations

State functions for room/participants to use within composables.

Types

AgentState

enum AgentState : Enum<AgentState>

ParticipantInfo

@Immutable

data class ParticipantInfo(val name: String?, val identity: Participant.Identity?, val metadata: String?)

Holder for basic Participant information.

RoomInfo

@Immutable

data class RoomInfo(val name: String?, val metadata: String?)

Holder for basic Room information.

VoiceAssistant

data class VoiceAssistant(val agent: RemoteParticipant?, val state: AgentState, val audioTrack: TrackReference?, val agentTranscriptions: List<TranscriptionSegment>, val agentAttributes: Map<String, String>?)

Properties

PARTICIPANT_ATTRIBUTE_LK_AGENT_STATE_INITIALIZING

const val PARTICIPANT_ATTRIBUTE_LK_AGENT_STATE_INITIALIZING: String

PARTICIPANT_ATTRIBUTE_LK_AGENT_STATE_KEY

const val PARTICIPANT_ATTRIBUTE_LK_AGENT_STATE_KEY: String

PARTICIPANT_ATTRIBUTE_LK_AGENT_STATE_LISTENING

const val PARTICIPANT_ATTRIBUTE_LK_AGENT_STATE_LISTENING: String

PARTICIPANT_ATTRIBUTE_LK_AGENT_STATE_SPEAKING

const val PARTICIPANT_ATTRIBUTE_LK_AGENT_STATE_SPEAKING: String

PARTICIPANT_ATTRIBUTE_LK_AGENT_STATE_THINKING

const val PARTICIPANT_ATTRIBUTE_LK_AGENT_STATE_THINKING: String

Functions

getTrackReferences

fun Room.getTrackReferences(sources: List<Track.Source>, usePlaceholders: Set<Track.Source> = emptySet(), onlySubscribed: Boolean = true): List<TrackReference>

getTrackReferencesBySource

fun Participant.getTrackReferencesBySource(sources: List<Track.Source>, usePlaceholders: Set<Track.Source> = emptySet(), onlySubscribed: Boolean = true): List<TrackReference>

rememberAgentState

@Composable

fun rememberAgentState(participant: Participant?): AgentState

Keeps track of the agent state for a participant.

rememberConnectionState

@Composable

fun rememberConnectionState(passedRoom: Room? = null): Room.State

Returns the Room.State from passedRoom or the local RoomScope if null.

rememberParticipantInfo

@Composable

fun rememberParticipantInfo(passedParticipant: Participant? = null): ParticipantInfo

Remembers the participant info and updates whenever it is changed.

rememberParticipants

@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.

rememberParticipantTrackReferences

@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? = null, 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.

rememberRoomInfo

@Composable

fun rememberRoomInfo(passedRoom: Room? = null): RoomInfo

Remembers the room info and updates whenever it is changed.

rememberTrack

@Composable

fun <T : Track> rememberTrack(trackIdentifier: TrackIdentifier): T?

Observes the trackIdentifier object for the track.

rememberTrackMuted

@Composable

fun rememberTrackMuted(trackRef: TrackReference): Boolean

rememberTracks

@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.

rememberVoiceAssistant

@Composable

fun rememberVoiceAssistant(passedRoom: Room? = null): VoiceAssistant

This looks for the first agent-participant in the room.