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

Package-level declarations

State functions for room/participants to use within composables.

Types

abstract class Agent

A representation of an LiveKit agent participant.

enum AgentState : Enum<AgentState>

ParticipantInfo

class ParticipantInfo(nameState: State<String?>, identityState: State<Participant.Identity?>, metadataState: State<String?>)

Holder for basic Participant information.

class RoomInfo(nameState: State<String?>, metadataState: State<String?>)

Holder for basic Room information.

abstract class Session

A Session represents a managed connection to a Room which can contain Agents.

SessionConnectOptions

data class SessionConnectOptions(val tracks: SessionConnectTrackOptions = SessionConnectTrackOptions(), val roomConnectOptions: ConnectOptions = ConnectOptions())

Options for connecting to a session.

SessionConnectTrackOptions

data class SessionConnectTrackOptions(val microphoneEnabled: Boolean = true, val usePreconnectBuffer: Boolean = true, val microphoneCaptureOptions: LocalAudioTrackOptions = LocalAudioTrackOptions(), val microphonePublishOptions: AudioTrackPublishOptions = AudioTrackPublishOptions())

Track options for session connection.

SessionMessages

abstract class SessionMessages

Handles all the messages that are sent and received within a Session.

data class SessionOptions(val room: Room? = null, val agentConnectTimeout: Duration = 20.seconds, val tokenRequestOptions: TokenRequestOptions = TokenRequestOptions())

Options for creating a Session.

class VoiceAssistant(agent: State<RemoteParticipant?>, state: State<AgentState?>, audioTrack: State<TrackReference?>, agentTranscriptions: State<List<TextStreamData>>, agentAttributes: State<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>

fun rememberAgent(session: Session? = null): Agent

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

rememberAgentState

fun rememberAgentState(participant: Participant?): State<AgentState>

Keeps track of the agent state for a participant.

rememberConnectionState

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

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

rememberLocalMedia

fun rememberLocalMedia(room: Room? = null): LocalMedia

rememberParticipantInfo

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

Remembers the participant info and updates whenever it is changed.

rememberParticipants

fun rememberParticipants(passedRoom: Room? = null): State<List<Participant>>

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

rememberParticipantTrackReferences

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): State<List<TrackReference>>

fun rememberParticipantTrackReferences(sources: List<Track.Source>, participantIdentity: Participant.Identity? = null, passedRoom: Room? = null, usePlaceholders: Set<Track.Source> = emptySet(), onlySubscribed: Boolean = true): State<List<TrackReference>>

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

rememberRoomInfo

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

Remembers the room info and updates whenever it is changed.

rememberSession

fun rememberSession(tokenSource: TokenSource, options: SessionOptions = SessionOptions()): Session

rememberSessionMessages

fun rememberSessionMessages(session: Session? = null): SessionMessages

rememberSpeakingParticipants

fun rememberSpeakingParticipants(room: Room? = null): State<List<Participant>>

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

Observes the trackIdentifier object for the track.

rememberTrackMuted

fun rememberTrackMuted(trackRef: TrackReference): State<Boolean>

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): State<List<TrackReference>>

Returns an array of TrackReferences depending the sources provided.

rememberVoiceAssistant

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

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