Table of Contents

Namespace LiveKit.Proto

Protobuf enums and messages of the LiveKit FFI that the LiveKit.Rtc API uses: track kinds and sources, codecs, connection states, participant permissions, statistics and the like. Only the types the public API uses are documented; the others are internal to the SDK.

Classes

AudioPlayoutStats
AudioSourceStats
CandidatePairStats
CertificateStats
ChatMessage
CodecStats
DataChannelStats
FrameMetadata
IceCandidateStats
InboundRtpStreamStats
MediaSourceStats
OutboundRtpStreamStats
ParticipantPermission

copied from livekit-protocol/protocol/protobufs/livekit_models.proto and removed deprecated fields

ParticipantTrackPermission
PeerConnectionStats
ReceivedRtpStreamStats
RemoteInboundRtpStreamStats
RemoteOutboundRtpStreamStats
RoomInfo
RtcStats
RtcStats.Types

Container for nested types declared in the RtcStats message type.

RtcStats.Types.CandidatePair
RtcStats.Types.Certificate
RtcStats.Types.Codec
RtcStats.Types.DataChannel
RtcStats.Types.InboundRtp
RtcStats.Types.LocalCandidate
RtcStats.Types.MediaPlayout
RtcStats.Types.MediaSource
RtcStats.Types.OutboundRtp
RtcStats.Types.PeerConnection
RtcStats.Types.RemoteCandidate
RtcStats.Types.RemoteInboundRtp
RtcStats.Types.RemoteOutboundRtp
RtcStats.Types.Stream
RtcStats.Types.Track

Deprecated

RtcStats.Types.Transport
RtcStatsData
RtpStreamStats
SentRtpStreamStats
StreamStats
TranscriptionSegment
TransportStats
VideoSourceStats

Enums

ConnectionQuality
ConnectionState
DataChannelState
DataPacketKind
DegradationPreference

Controls how the encoder degrades quality when bandwidth is constrained.

DisconnectReason
DtlsRole
DtlsTransportState
EncodedFrameType
EncryptionState
EncryptionType
FrameMetadataFeature
IceCandidatePairState
IceCandidateType
IceRole
IceServerTransportProtocol
IceTcpCandidateType
IceTransportState
KeyDerivationFunction
LocalDataTrackTryPushErrorCode
ParticipantKind
ParticipantState
PublishDataTrackErrorCode
QualityLimitationReason
RtcStats.StatsOneofCase

Enum of possible cases for the "stats" oneof.

SimulateScenarioKind

Simulate a reconnection scenario for testing. Mirrors the variants of livekit::SimulateScenario. The Resume / FullReconnect variants are the relevant ones for verifying that resume preserves publications and full reconnect republishes them exactly once.

SoxQualityRecipe
SubscribeDataTrackErrorCode
TrackKind
TrackSource
VideoBufferType

Values of this enum must not be changed It is used to serialize a rtc.VideoFrame on Python

VideoCodec
VideoEncoderBackend
VideoQuality

Video quality for simulcasted tracks.

VideoRotation