Table of Contents

Namespace LiveKit

Classes

AudioFrame
AudioResampler
AudioStream

An audio stream from a remote participant, attached to an AudioSource in the scene.

BasicAudioSource

An audio source which captures from a Unity AudioSource in the scene.

BiplanarYuv8Buffer
BiplanarYuvBuffer
ByteStreamInfo

Information about a byte data stream.

ByteStreamReader

Reader for an incoming byte data stream.

ByteStreamReader.ReadAllInstruction

YieldInstruction for ReadAll().

ByteStreamReader.ReadIncrementalInstruction

YieldInstruction for ReadIncremental().

ByteStreamReader.WriteToFileInstruction

YieldInstruction for WriteToFile(string, string).

ByteStreamWriter

Writer for an outgoing byte data stream.

ByteStreamWriter.CloseInstruction

YieldInstruction for Close(string).

ByteStreamWriter.WriteInstruction

YieldInstruction for Write(byte[]).

CameraVideoSource
ConnectInstruction
DataTrackFrame

A frame published on a data track, consisting of a payload and optional metadata.

DataTrackInfo

Information about a published data track.

DataTrackOptions

Options for publishing a data track.

DataTrackStream

An active subscription to a remote data track.

DataTrackStream.ReadFrameInstruction

YieldInstruction for reading a single frame from a DataTrackStream.

DataTrackSubscribeOptions

Options for subscribing to a remote data track.

E2EEManager
E2EEOptions
FrameCryptor
GetSessionStatsInstruction
I010Buffer
I420ABuffer
I420Buffer
I422Buffer
I444Buffer
IRtcSource
IceServer
KeyProvider
KeyProviderOptions
LocalAudioTrack
LocalDataTrack

Data track published by the local participant.

LocalParticipant
LocalTrackPublication
LocalVideoTrack
MicrophoneSource

An audio source which captures from the device's microphone.

NV12Buffer
NativeBuffer
PackageVersion
Participant
PerformRpcInstruction

YieldInstruction for RPC calls. Returned by PerformRpc(PerformRpcParams).

PerformRpcParams

Parameters for PerformRpc(PerformRpcParams).

PlanarYuv16BBuffer
PlanarYuv8Buffer
PlanarYuvBuffer
PublishDataTrackError

An error that can occur when publishing a data track.

PublishDataTrackInstruction

YieldInstruction for publishing a data track. Returned by PublishDataTrack(DataTrackOptions).

PublishTrackInstruction
PushFrameError

An error that can occur when pushing a frame to a data track.

RGBABBuffer
RTCConfiguration
RemoteAudioTrack
RemoteDataTrack

Data track published by a remote participant.

RemoteParticipant
RemoteTrackPublication
RemoteVideoTrack
Room
RoomOptions
RpcError

Errors thrown by RPC method handlers or generated due to a failure in the RPC call.

Built-in error codes are listed in RpcError.ErrorCode.

You may also throw custom errors with your own code and data.
Errors of this type thrown in your handler will be transmitted as-is without modification. All other errors will be converted to a generic APPLICATION_ERROR (1500).

RpcInvocationData

Data supplied to an RPC method handler registered with RegisterRpcMethod(string, RpcHandler).

RtcAudioSource

Capture source for a local audio track.

RtcVideoSource
ScreenVideoSource
SendFileInstruction

YieldInstruction for send file. Returned by SendFile(string, StreamByteOptions).

SendTextInstruction

YieldInstruction for send text. Returned by SendText(string, StreamTextOptions).

SetLocalAttributesInstruction
SetLocalMetadataInstruction
SetLocalNameInstruction
StreamByteOptions

Options used when opening an outgoing byte data stream.

StreamBytesInstruction

YieldInstruction for stream bytes. Returned by StreamBytes(StreamByteOptions).

StreamError

Error for data stream operations.

StreamInfo

Information about a data stream.

StreamOptions

Options used when opening an outgoing data stream.

StreamTextInstruction

YieldInstruction for stream text. Returned by StreamText(StreamTextOptions).

StreamTextOptions

Options used when opening an outgoing text data stream.

StreamYieldInstruction
SubscribeDataTrackError

An error that can occur when subscribing to a data track.

TextStreamInfo

Information about a text data stream.

TextStreamReader

Reader for an incoming text data stream.

TextStreamReader.ReadAllInstruction

YieldInstruction for ReadAll().

TextStreamReader.ReadIncrementalInstruction

YieldInstruction for ReadIncremental().

TextStreamWriter

Writer for an outgoing text data stream.

TextStreamWriter.CloseInstruction

YieldInstruction for Close(string).

TextStreamWriter.WriteInstruction

YieldInstruction for Write(string).

TextureVideoSource
ThreadSafeQueue<T>
Track
TrackPublication
UnpublishTrackInstruction
VideoFrame
VideoFrameBuffer
VideoStream
WebCameraSource
YieldInstruction

Interfaces

IAudioTrack
ILocalTrack
IRemoteTrack
ITrack
IVideoTrack

Enums

ContinualGatheringPolicy
EncryptionType
IceTransportType
RpcError.ErrorCode

Built-in error codes. See https://docs.livekit.io/home/client/data/rpc/#errors for more information.

RtcAudioSourceType

Defines the type of audio source, influencing processing behavior.

RtcVideoSource.VideoStreamSource
TextStreamInfo.OperationType

Operation type for text streams.

Delegates

ByteStreamHandler

Delegate for handling incoming byte data streams.

Participant.PublishDelegate
Room.ConnectionDelegate
Room.ConnectionQualityChangeDelegate
Room.ConnectionStateChangeDelegate
Room.DataDelegate
Room.DataTrackPublishedDelegate
Room.DataTrackUnpublishedDelegate
Room.E2EeStateChangedDelegate
Room.LocalPublishDelegate
Room.MetaDelegate
Room.MuteDelegate
Room.ParticipantDelegate
Room.PublishDelegate
Room.RemoteParticipantDelegate
Room.SipDtmfDelegate
Room.SpeakersChangeDelegate
Room.SubscribeDelegate
RpcHandler
RtcVideoSource.TextureReceiveDelegate
TextStreamHandler

Delegate for handling incoming text data streams.

VideoStream.FrameReceiveDelegate
VideoStream.TextureReceiveDelegate
VideoStream.TextureUploadDelegate