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

Package-level declarations

Utilities to observe Room events and data flows.

Types

Link copied to clipboard
@Stable
class DataHandler(val messageFlow: Flow<DataMessage>, send: suspend (payload: ByteArray, options: DataSendOptions) -> Unit)

A state holder for handling data messages.

Link copied to clipboard
data class DataMessage(val topic: String?, val payload: ByteArray, val participant: Participant?)

A representation of a message sent/received through LiveKit.

Link copied to clipboard
data class DataSendOptions(val reliability: DataPublishReliability, val identities: List<Participant.Identity>? = null)

Options for publishing data channel messages.

Link copied to clipboard
enum DataTopic : Enum<DataTopic>

Standard topics for use with rememberDataMessageHandler

Link copied to clipboard
enum LegacyDataTopic : Enum<LegacyDataTopic>

Legacy topics for use with rememberDataMessageHandler

Link copied to clipboard
data class TextStreamData(val text: String, val participantIdentity: Participant.Identity, val streamInfo: StreamInfo)

A representation of the aggregated data from a text stream.

Functions

Link copied to clipboard
@Composable
fun rememberDataMessageHandler(room: Room, topic: LegacyDataTopic): DataHandler
@Composable
fun rememberDataMessageHandler(room: Room, topic: String? = null): DataHandler

Creates a DataHandler that is remembered across recompositions. It listens to the specified topic and emits all the messages through DataHandler.messageFlow. Any messages sent through DataHandler.sendMessage will be sent on the specified topic.

Link copied to clipboard
@Composable
inline fun <T : U, U> rememberEventSelector(eventListenable: EventListenable<U>): Flow<T>

A utility method to obtain a flow for events.

@Composable
inline fun <T : RoomEvent> rememberEventSelector(room: Room): Flow<T>
@Composable
inline fun <T : ParticipantEvent> rememberEventSelector(participant: Participant): Flow<T>
@Composable
inline fun <T : TrackPublicationEvent> rememberEventSelector(publication: TrackPublication): Flow<T>

A utility method to obtain a flow for specific room events.

@Composable
inline fun <T : TrackEvent> rememberEventSelector(track: Track): Flow<T>

A utility method to obtain a flow for specific track events.