livekit_client
library
Classes
ActiveSpeakersChangedEvent
Active speakers changed. List of speakers are ordered by their audio level.
loudest speakers first. This will include the LocalParticipant too.
AgentAttributes
AudioCaptureOptions
Options used when creating a LocalAudioTrack .
AudioOutputOptions
AudioPlaybackStatusChanged
AudioPreset
AudioProcessorOptions
AudioPublishOptions
Options used when publishing audio.
AudioReceiverStatsEvent
AudioSenderStatsEvent
AudioVisualizer
AudioVisualizerEvent
AudioVisualizerOptions
BackupVideoCodec
BaseKeyProvider
BaseStreamInfo
BaseStreamReader <T extends BaseStreamInfo , U >
BaseStreamWriter <T , InfoType extends BaseStreamInfo >
BrowserVersion
ByteStreamInfo
ByteStreamReader
ByteStreamWriter
CameraCaptureOptions
Options used when creating a LocalVideoTrack that captures the camera.
ChatMessage
ConnectOptions
Options used when connecting to the server.
DataReceivedEvent
Data received from RemoteParticipant .
Data packets provides the ability to use LiveKit to send/receive arbitrary
payloads.
Emitted by Room and RemoteParticipant .
DataStreamController <T extends DataStream_Chunk >
E2EEManager
E2EEOptions
EnumValues <T >
EventsEmitter <T >
EventsListenable <T >
EventsListener <T >
FastConnectOptions
This will enable the local participant to publish tracks on connect,
instead of having to explicitly publish them.
Defaults to false for all three tracks: microphone, camera, and screen.
You can also create LocalAudio/VideoTrack on your PreJoin page
(preview camera or select audio device), Automatically publish these
tracks after the room is connected.
Hardware
KeyInfo
KeyProvider
LiveKitClient Room
Main entry point to connect to a room.
LocalAudioTrack
LocalParticipant
Represents the current participant in the room. Instance of LocalParticipant is automatically
created after successfully connecting to a Room and will be accessible from Room.localParticipant .
LocalTrack
Base class for LocalAudioTrack and LocalVideoTrack .
LocalTrackOptions
Base class for track options.
LocalTrackPublication <T extends LocalTrack >
A TrackPublication which belongs to the LocalParticipant .
LocalTrackPublishedEvent
When the local participant publishes a new Track to the room.
Emitted by Room and LocalParticipant .
LocalTrackSubscribedEvent
LocalTrackUnpublishedEvent
The local participant has unpublished one of their Track .
Emitted by Room and LocalParticipant .
LocalVideoTrack
A video track from the local device. Use static methods in this class to create
video tracks.
MediaDevice
Participant <T extends TrackPublication <Track >
Represents a Participant in the room, notifies changes via delegates as
well as ChangeNotifier/providers.
A change notification is triggered when
ParticipantAttributesChanged
Participant's attributes have changed.
Emitted by Room .
ParticipantConnectedEvent
When a new RemoteParticipant joins after the current participant has connected
It will not fire for participants that are already in the room
Emitted by Room .
ParticipantConnectionQualityUpdatedEvent
Pariticpant's ConnectionQuality has updated.
Emitted by Room and Participant .
ParticipantDisconnectedEvent
When a RemoteParticipant leaves the room
Emitted by Room .
ParticipantMetadataUpdatedEvent
Participant metadata is a simple way for app-specific state to be pushed to
all users. When RoomService.UpdateParticipantMetadata is called to change a
Participant 's state, all Participant s in the room will fire this event.
Emitted by Room and Participant .
ParticipantNameUpdatedEvent
ParticipantPermissions
ParticipantPermissionsUpdatedEvent
The ParticipantPermissions updated for the Participant .
Currently, only for LocalParticipant .
Emitted by Room and LocalParticipant .
ParticipantStateUpdatedEvent
ParticipantTrackPermission
PerformRpcParams
ProcessorOptions <T extends TrackType >
PublishOptions
RemoteAudioTrack
RemoteParticipant
Represents other participant in the Room .
RemoteTrack
RemoteTrackPublication <T extends RemoteTrack >
Represents a track publication from a RemoteParticipant. Provides methods to
control if we should subscribe to the track, and its quality (for video).
RemoteVideoTrack
Room Room
Room is the primary construct for LiveKit conferences. It contains a
group of Participant s, each publishing and subscribing to Track s.
Notifies changes to its state via two ways, by assigning a delegate, or using
it as a provider.
Room will trigger a change notification update when
RoomAttemptReconnectEvent
report the number of attempts to reconnect to the room.
RoomConnectedEvent
RoomDisconnectedEvent
Disconnected from the room
Emitted by Room .
RoomMetadataChangedEvent
Room metadata has changed.
Emitted by Room .
RoomOptions Room
Options used to modify the behavior of the Room .
RoomReconnectedEvent
Connection to room is re-established. All existing state is preserved.
Emitted by Room .
RoomReconnectingEvent
When the connection to the server has been interrupted and it's attempting
to reconnect.
Emitted by Room .
RoomRecordingStatusChanged
Room recording status has changed.
Emitted by Room .
RpcInvocationData
RTCConfiguration
RTCIceServer
ScreenSelectDialog
ScreenShareCaptureOptions
Options used when creating a LocalVideoTrack that captures the screen.
SendFileOptions
SendTextOptions
SimulcastTrackInfo
SpeakingChangedEvent
The participant's isSpeaking property has changed
Emitted by Participant .
StreamBytesOptions
StreamTextOptions
StreamWriter <T >
TextStreamInfo
TextStreamReader
TextStreamWriter
ThumbnailWidget
ThumbnailWidgetState
Timeouts
Track
Wrapper around a MediaStreamTrack with additional metadata.
Base for AudioTrack and VideoTrack ,
can not be instantiated directly.
TrackE2EEStateEvent
The E2EEState on the track.
Emitted by E2EEManager .
TrackMutedEvent
A Participant has muted one of the track.
Emitted by RemoteParticipant and LocalParticipant .
TrackOption <E extends Object , T extends Object >
TrackProcessor <T extends ProcessorOptions <TrackType >
TrackProcessorUpdateEvent
TrackPublication <T extends Track >
Represents a track that's published to the server. This class contains
metadata associated with tracks.
TrackPublishedEvent
When a new Track is published to Room after the current participant has
joined. It will not fire for tracks that are already published.
Emitted by Room and RemoteParticipant .
TrackStreamStateUpdatedEvent
The StreamState on the RemoteTrackPublication has updated by the server.
See RemoteTrackPublication.streamState for more information.
Emitted by Room and RemoteParticipant .
TrackSubscribedEvent
LocalParticipant has subscribed to a new track published by a
RemoteParticipant .
Emitted by Room and RemoteParticipant .
TrackSubscriptionExceptionEvent
An error has occured during track subscription.
Emitted by Room and RemoteParticipant .
TrackSubscriptionPermissionChangedEvent
One of subscribed tracks have changed its permissions for the current
participant. If permission was revoked, then the track will no longer
be subscribed. If permission was granted, a TrackSubscribed event will
be emitted.
TrackUnmutedEvent
This participant has unmuted one of their tracks
Emitted by RemoteParticipant and LocalParticipant .
TrackUnpublishedEvent
The participant has unpublished one of their Track .
Emitted by Room and RemoteParticipant .
TrackUnsubscribedEvent
The LocalParticipant has unsubscribed from a track published by a
RemoteParticipant . This event is fired when the track was unpublished.
Emitted by Room and RemoteParticipant .
TranscriptionAttributes
Schema for transcription-related attributes
TranscriptionEvent
Transcription event received from the server.
TranscriptionSegment
VideoCaptureOptions
Base class for options when creating a LocalVideoTrack .
VideoDimensions
A simple class that represents dimensions of video.
VideoEncoding
A type that represents video encoding information.
VideoParameters
VideoProcessorOptions
VideoPublishOptions
Options used when publishing video.
VideoReceiverStatsEvent
VideoSenderStatsEvent
VideoTrackRenderer
Widget that renders a VideoTrack .
WritableStream <T >
