Namespace LiveKit

Unlike MicrophoneSource which uses Unity's Microphone API and manually pushes audio frames, PlatformAudioSource lets WebRTC's ADM handle capture directly. This provides:

Echo cancellation (AEC) that works with speaker playout
Lower latency (single audio path, no Unity intermediate)
Automatic gain control and noise suppression

Requires PlatformAudio to be created first to enable the ADM.

PublishDataInstruction: YieldInstruction for publishing data packets. Returned by PublishData(byte[], IReadOnlyCollection<string>, bool, string).

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

ReadIncrementalInstructionBase<TContent>: Shared state and helpers for incremental stream reader yield instructions. Models the incoming stream as a single ordered queue whose items are either a chunk or a the end-of-stream marker (carrying an optional StreamError). The consumer advances through the queue one item at a time via Reset(); end-of-stream is only observed once every buffered chunk has been drained, mirroring the JS and Python SDKs. Subclasses own the typed event subscription and convert raw event payloads via OnChunk(TContent) and OnEos(StreamError).

RemoteAudioTrack

RemoteDataTrack: Data track published by a remote participant.

RemoteDataTrackPipelineOptions: Track-level options that configure how the incoming-frame pipeline reassembles packets for a remote data track.

RemoteParticipant

RemoteTrackPublication

RemoteVideoTrack

RingBuffer

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.

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

TokenSourceComponent: MonoBehaviour wrapper that builds an ITokenSource from an inspector-assigned TokenSourceComponentConfig ScriptableObject. To skip the asset entirely, instantiate TokenSourceLiteral, TokenSourceSandbox, TokenSourceEndpoint, or TokenSourceCustom directly at runtime.

TokenSourceComponentConfig

TokenSourceCustom: Delegates connection-detail retrieval to a user-supplied async function. Use this when your app already has its own token-fetching code (custom auth flow, cached tokens, etc.).

TokenSourceEndpoint: Posts a JSON request to a token-server endpoint and returns the parsed ConnectionDetails. The body is built from per-call TokenSourceFetchOptions (room name, participant info, agent dispatch, etc.). Use for production token servers — see https://docs.livekit.io/frontends/build/authentication/endpoint/.

TokenSourceFetchOptions: Per-call overrides passed to FetchConnectionDetails(TokenSourceFetchOptions).

TokenSourceLiteral: Returns a fixed server URL and participant token. Suitable when credentials are pregenerated (e.g. via the LiveKit CLI or LiveKit Cloud project page).

TokenSourceSandbox: Convenience TokenSourceEndpoint preconfigured for LiveKit Cloud sandbox token servers. Intended for development and testing only — see https://docs.livekit.io/frontends/build/authentication/sandbox-token-server/.

Track

TrackPublication

TrackPublishOptionsExtensions

UnpublishTrackInstruction

VideoFrame

VideoFrameBuffer

VideoStream

WebCameraSource

Structs

AudioDevice: Information about an audio device (microphone or speaker).

AudioProcessingOptions: Options for audio processing when creating a PlatformAudioSource.

StringPair

Interfaces

IAudioTrack

ILocalTrack

IRemoteTrack

ITokenSource: Marker interface for any source of LiveKit ConnectionDetails. Implementations are either ITokenSourceFixed or ITokenSourceConfigurable.

ITokenSourceConfigurable: A token source that accepts per-call TokenSourceFetchOptions to parameterize the request (e.g. an HTTP endpoint that needs room/participant info per fetch).

ITokenSourceFixed: A token source whose connection details are fully determined at construction time and cannot be influenced by per-call options (e.g. literal credentials or a user-supplied callback).