Namespace LiveKit.Proto
Classes
- AgentDB
Nested so that names like Value and Ping need not be unique across the livekit package.
tipthroughout is the latest durable commit sequence.
- AgentDB.Types
Container for nested types declared in the AgentDB message type.
- AgentDB.Types.AgentDatabase
One database, as get and list both report it.
- AgentDB.Types.Wire
Data plane: one WebSocket per database, one message per frame, correlated by a client-chosen request_id. Result batches are paced by Credit, so the server never sends more un-consumed batches than granted.
- AgentDB.Types.Wire.Types
Container for nested types declared in the Wire message type.
- AgentDB.Types.Wire.Types.Column
Values are typed per row, as SQLite types them, so a column may mix classes: walk
typesand take the next entry from the matching array. Text and blobs are concatenated with one exclusive end offset each, so value i is data[ends[i-1]:ends[i]] with 0 implied before the first. A NULL occupies a tag only.
- AgentDB.Types.Wire.Types.Value
SQLite's five storage classes.
- AudioConfig
Unified audio selection and channel routing. Each route specifies both which audio to capture and which channel to output to.
- ClientConfiguration
server provided client configuration
- ClientInfo
details about the client
- ClientInfo.Types
Container for nested types declared in the ClientInfo message type.
- ConnectTwilioCallRequest.Types
Container for nested types declared in the ConnectTwilioCallRequest message type.
- CreatePrivateLinkRequest.Types
Container for nested types declared in the CreatePrivateLinkRequest message type.
- CreateSIPParticipantRequest
A SIP Participant is a singular SIP session connected to a LiveKit room via a SIP Trunk into a SIP DispatchRule
- DataBlob
A blob of data stored in a room identified by a unique key.
- DataBlobKey
Key used to uniquely identify a data blob for storage and retrieval.
- DataPacket
new DataPacket API
- DataPacket.Types
Container for nested types declared in the DataPacket message type.
- DataStream.Types
Container for nested types declared in the DataStream message type.
- DataStream.Types.ByteHeader
header properties specific to byte or file streams
- DataStream.Types.Header
main DataStream.Header that contains a oneof for specific headers
- DataStream.Types.TextHeader
header properties specific to text streams
- DataTrackFrameEncoding
Encoding for frame payloads.
- DataTrackFrameEncoding.Types
Container for nested types declared in the DataTrackFrameEncoding message type.
- DataTrackSchemaEncoding
Encoding for schema definition.
- DataTrackSchemaEncoding.Types
Container for nested types declared in the DataTrackSchemaEncoding message type.
- DataTrackSchemaId
Identifier for a data track schema.
Schemas with the same name but different encodings are distinct.
- DataTrackSubscriberHandles.Types
Container for nested types declared in the DataTrackSubscriberHandles message type.
- DisconnectWhatsAppCallRequest.Types
Container for nested types declared in the DisconnectWhatsAppCallRequest message type.
- Encryption.Types
Container for nested types declared in the Encryption message type.
- FeatureUsageInfo.Types
Container for nested types declared in the FeatureUsageInfo message type.
- FileOutput
Unified file output — replaces v1 EncodedFileOutput and DirectFileOutput. Whether transcoded depends on encoding options on the request.
- GetPhoneNumberRequest
GetPhoneNumberRequest - Request to get a phone number
- GetPhoneNumberResponse
GetPhoneNumberResponse - Response containing the phone number
- ImageOutput
Capture images at a specified interval
- IngressState.Types
Container for nested types declared in the IngressState message type.
- LeaveRequest.Types
Container for nested types declared in the LeaveRequest message type.
- ListPhoneNumbersRequest
ListPhoneNumbersRequest - Request to list phone numbers
- ListPhoneNumbersResponse
ListPhoneNumbersResponse - Response containing phone numbers
- ListSIPDispatchRuleRequest
ListSIPDispatchRuleRequest lists dispatch rules for given filters. If no filters are set, all rules are listed.
- ListSIPInboundTrunkRequest
ListSIPInboundTrunkRequest lists inbound trunks for given filters. If no filters are set, all trunks are listed.
- ListSIPOutboundTrunkRequest
ListSIPOutboundTrunkRequest lists outbound trunks for given filters. If no filters are set, all trunks are listed.
- ListUpdate
ListUpdate is used for updated APIs where 'repeated string' field is modified.
- LivekitAgentDispatchReflection
Holder for reflection information generated from livekit_agent_dispatch.proto
- LivekitAgentReflection
Holder for reflection information generated from livekit_agent.proto
- LivekitAgentSimulationReflection
Holder for reflection information generated from livekit_agent_simulation.proto
- LivekitAgentTextReflection
Holder for reflection information generated from agent/livekit_agent_text.proto
- LivekitAgentWorkerReflection
Holder for reflection information generated from livekit_agent_worker.proto
- LivekitAgentdbReflection
Holder for reflection information generated from livekit_agentdb.proto
- LivekitAnalyticsReflection
Holder for reflection information generated from livekit_analytics.proto
- LivekitCloudAgentReflection
Holder for reflection information generated from livekit_cloud_agent.proto
- LivekitConnectorReflection
Holder for reflection information generated from livekit_connector.proto
- LivekitConnectorTwilioReflection
Holder for reflection information generated from livekit_connector_twilio.proto
- LivekitConnectorWhatsappReflection
Holder for reflection information generated from livekit_connector_whatsapp.proto
- LivekitEgressReflection
Holder for reflection information generated from livekit_egress.proto
- LivekitIngressReflection
Holder for reflection information generated from livekit_ingress.proto
- LivekitInternalReflection
Holder for reflection information generated from livekit_internal.proto
- LivekitMetricsReflection
Holder for reflection information generated from livekit_metrics.proto
- LivekitModelsReflection
Holder for reflection information generated from livekit_models.proto
- LivekitPhoneNumberReflection
Holder for reflection information generated from livekit_phone_number.proto
- LivekitRoomReflection
Holder for reflection information generated from livekit_room.proto
- LivekitRtcReflection
Holder for reflection information generated from livekit_rtc.proto
- LivekitSipReflection
Holder for reflection information generated from livekit_sip.proto
- LivekitTokenSourceReflection
Holder for reflection information generated from livekit_token_source.proto
- LivekitWebhookReflection
Holder for reflection information generated from livekit_webhook.proto
- MediaSource
Capture tracks directly from a room via SDK. Unifies deprecated Participant, TrackComposite, and Track egress.
- NodeStatsRate
rates of different node stats (per second)
- OptionsExtensions
Holder for extension identifiers generated from the top level of logger/options.proto
- OptionsReflection
Holder for reflection information generated from logger/options.proto
- ParticipantInfo.Types
Container for nested types declared in the ParticipantInfo message type.
- PhoneNumber
PhoneNumber - Unified phone number type for inventory and purchased numbers
- PrivateLink.Types
Container for nested types declared in the PrivateLink message type.
- PrivateLinkStatus.Types
Container for nested types declared in the PrivateLinkStatus message type.
- PurchasePhoneNumberRequest
PurchasePhoneNumberRequest - Request to purchase phone numbers
- PurchasePhoneNumberResponse
PurchasePhoneNumberResponse - Response containing the purchased phone numbers
- ReleasePhoneNumbersRequest
ReleasePhoneNumbersRequest - Request to release phone numbers
- ReleasePhoneNumbersResponse
ReleasePhoneNumbersResponse - Response for releasing phone numbers
- RequestResponse.Types
Container for nested types declared in the RequestResponse message type.
- RoomInternal
room info that should not be returned to clients
- SIPStatus
SIPStatus is returned as an error detail in CreateSIPParticipant.
- SIPTransferError
Details of a failed SIP transfer, attached to the error.
- SIPTrunkInfo.Types
Container for nested types declared in the SIPTrunkInfo message type.
- Scenario
A single scenario, mirroring one entry in a scenarios.yaml file. Scenarios are no longer stored server-side; the yaml file is the source of truth.
- Scenario.Types
Container for nested types declared in the Scenario message type.
- Scenario.Types.CreateFromSession.Types
Container for nested types declared in the CreateFromSession message type.
- ScenarioGroup
A named group of scenarios, mirroring a whole scenarios.yaml file.
- SearchPhoneNumbersRequest
SearchPhoneNumbersRequest - Request to search available phone numbers
- SearchPhoneNumbersResponse
SearchPhoneNumbersResponse - Response containing available phone numbers
- SegmentedFileOutput
Used to generate HLS segments or other kind of segmented output
- ServerInfo
details about the server
- ServerInfo.Types
Container for nested types declared in the ServerInfo message type.
- ServerMessage
from Server to Worker
- SimulationDispatch
Carried (protojson-encoded) in the simulation room's metadata so the agent under test can read the scenario + run identity synchronously at connect.
- SimulationRun.Types
Container for nested types declared in the SimulationRun message type.
- SimulationRun.Types.CI
The pipeline this run came from. Set by the client from its CI environment; absent for runs not started by a pipeline.
- SimulationRun.Types.Cancel.Types
Container for nested types declared in the Cancel message type.
- SimulationRun.Types.ConfirmSourceUpload.Types
Container for nested types declared in the ConfirmSourceUpload message type.
- SimulationRun.Types.Counts
Counts of the runs
Listwould return over the same window, bucketed by created_at instead of paginated.
- SimulationRun.Types.Counts.Types
Container for nested types declared in the Counts message type.
- SimulationRun.Types.Create.Types
Container for nested types declared in the Create message type.
- SimulationRun.Types.Get.Types
Container for nested types declared in the Get message type.
- SimulationRun.Types.Job.Types
Container for nested types declared in the Job message type.
- SimulationRun.Types.JobMetrics.Types
Container for nested types declared in the JobMetrics message type.
- SimulationRun.Types.JobMetrics.Types.STT
The agent's perception of the caller. Audio only.
- SimulationRun.Types.JobMetrics.Types.TTS
The agent's voice. Audio only.
- SimulationRun.Types.JobMetrics.Types.Turn
Rows exist for text and audio. The groups above hold the means and pools over these; anything not measured for a turn stays unset.
- SimulationRun.Types.List.Types
Container for nested types declared in the List message type.
- SimulationRun.Types.RunMetrics
Aggregates over this run's jobs, so a run summary does not have to pull every job and turn. Reuses the JobMetrics group shapes.
- SimulationRun.Types.Sampling
Runs each scenario more than once, so a flaky sample is distinguishable from a broken scenario. Both fields are required when it is present.
- SimulationRunSummary.Types
Container for nested types declared in the SimulationRunSummary message type.
- StreamInfo.Types
Container for nested types declared in the StreamInfo message type.
- TemplateSource
Room composite recording via layout template. Service generates token, constructs recorder URL, awaits start signal.
- TextMessageComplete
Indicates the text message session is complete.
- TextMessageRequest
Request to send a text message to an agent.
- TextMessageResponse
Response to a text message request, multiple responses may be sent for a single request until it is complete.
- TransferSIPParticipantResponse
Added in https://github.com/livekit/protocol/pull/1730. Not needed after all: will be rolled back to an empty message once STR_CALL_ENDED is reported as an error like every other failed transfer.
- UpdateDataSubscription.Types
Container for nested types declared in the UpdateDataSubscription message type.
- UpdatePhoneNumberRequest
UpdatePhoneNumberRequest - Request to update a phone number
- UpdatePhoneNumberResponse
UpdatePhoneNumberResponse - Response containing the updated phone number
- UpdateSubscriptionsResponse
empty for now
- UpdateVideoLayers
message to indicate published video track dimensions are changing
- VideoLayer
provide information about available spatial layers
- VideoLayer.Types
Container for nested types declared in the VideoLayer message type.
- WebSource
Record a custom URL via headless browser.
- WorkerMessage
from Worker to Server
- WrappedJoinRequest.Types
Container for nested types declared in the WrappedJoinRequest message type.
Enums
- APICallRequest.MessageOneofCase
Enum of possible cases for the "message" oneof.
- AgentDB.Types.Wire.Types.ClientMessage.MessageOneofCase
Enum of possible cases for the "message" oneof.
- AgentDB.Types.Wire.Types.ServerMessage.MessageOneofCase
Enum of possible cases for the "message" oneof.
- AgentDB.Types.Wire.Types.Value.ValueOneofCase
Enum of possible cases for the "value" oneof.
- AgentSessionState.DataOneofCase
Enum of possible cases for the "data" oneof.
- AudioRoute.MatchOneofCase
Enum of possible cases for the "match" oneof.
- AutoParticipantEgress.OptionsOneofCase
Enum of possible cases for the "options" oneof.
- AutoTrackEgress.OutputOneofCase
Enum of possible cases for the "output" oneof.
- BackupCodecPolicy
Policy for publisher to handle subscribers that are unable to support the primary codec of a track
- ClientInfo.Types.Capability
Optional capabilities advertised by the client at connect time. The SFU uses these flags to decide whether to enable features that require client-side support (e.g. passing RTP packet trailers through to the subscriber instead of stripping them).
- CreatePrivateLinkRequest.ConfigOneofCase
Enum of possible cases for the "config" oneof.
- DataBlobKey.KeyOneofCase
Enum of possible cases for the "key" oneof.
- DataPacket.ValueOneofCase
Enum of possible cases for the "value" oneof.
- DataSelector.MatchOneofCase
Enum of possible cases for the "match" oneof.
- DataStream.Types.CompressionType
The compression type of the whole data stream
This will only get populated when send to participants with a client protocol >= 2 which advertise a client capability of CAP_COMPRESSION_DEFLATE_RAW
- DataStream.Types.Header.ContentHeaderOneofCase
Enum of possible cases for the "content_header" oneof.
- DataStream.Types.OperationType
enum for operation types (specific to TextHeader)
- DataTrackFrameEncoding.Types.WellKnownFrameEncoding
Well-known encoding for frame payloads.
Mirrors the well-known message encodings from the MCAP spec: https://mcap.dev/spec/registry#message-encodings
- DataTrackFrameEncoding.ValueOneofCase
Enum of possible cases for the "value" oneof.
- DataTrackSchemaEncoding.Types.WellKnownSchemaEncoding
Well-known encoding for schema definition.
Mirrors the well-known schema encodings from the MCAP spec: https://mcap.dev/spec/registry#schema-encodings
- DataTrackSchemaEncoding.ValueOneofCase
Enum of possible cases for the "value" oneof.
- DirectFileOutput.OutputOneofCase
Enum of possible cases for the "output" oneof.
- EgressInfo.RequestOneofCase
Enum of possible cases for the "request" oneof.
- EgressInfo.ResultOneofCase
Enum of possible cases for the "result" oneof.
- EncodedFileOutput.OutputOneofCase
Enum of possible cases for the "output" oneof.
- EncryptedPacketPayload.ValueOneofCase
Enum of possible cases for the "value" oneof.
- ExportReplayRequest.EncodingOneofCase
Enum of possible cases for the "encoding" oneof.
- ExportReplayRequest.SourceOneofCase
Enum of possible cases for the "source" oneof.
- ImageOutput.OutputOneofCase
Enum of possible cases for the "output" oneof.
- IngressAudioOptions.EncodingOptionsOneofCase
Enum of possible cases for the "encoding_options" oneof.
- IngressVideoOptions.EncodingOptionsOneofCase
Enum of possible cases for the "encoding_options" oneof.
- LeaveRequest.Types.Action
indicates action clients should take on receiving this message
- MediaSource.VideoOneofCase
Enum of possible cases for the "video" oneof.
- MetricLabel
index from [0: MAX_LABEL_PREDEFINED_MAX_VALUE) are for predefined labels (
MetricLabel)
- Output.ConfigOneofCase
Enum of possible cases for the "config" oneof.
- ParticipantEgressRequest.OptionsOneofCase
Enum of possible cases for the "options" oneof.
- PhoneNumberStatus
Phone number status enumeration
- PhoneNumberType
Phone number type enumeration
- PrivateLink.ConfigOneofCase
Enum of possible cases for the "config" oneof.
- RTPForwarderState.CodecMungerOneofCase
Enum of possible cases for the "codec_munger" oneof.
- ReportInfo.MessageOneofCase
Enum of possible cases for the "message" oneof.
- RequestResponse.RequestOneofCase
Enum of possible cases for the "request" oneof.
- RoomCompositeEgressRequest.OptionsOneofCase
Enum of possible cases for the "options" oneof.
- RoomCompositeEgressRequest.OutputOneofCase
Enum of possible cases for the "output" oneof.
- RoomEndReason
why a room ended, reported on room-ended telemetry
- RpcResponse.ValueOneofCase
Enum of possible cases for the "value" oneof.
- SIPDispatchRule.RuleOneofCase
Enum of possible cases for the "rule" oneof.
- SIPNamedDest.UriOneofCase
Enum of possible cases for the "uri" oneof.
- SIPRequestDest.UriOneofCase
Enum of possible cases for the "uri" oneof.
- SegmentedFileOutput.OutputOneofCase
Enum of possible cases for the "output" oneof.
- ServerMessage.MessageOneofCase
Enum of possible cases for the "message" oneof.
- SignalRequest.MessageOneofCase
Enum of possible cases for the "message" oneof.
- SignalResponse.MessageOneofCase
Enum of possible cases for the "message" oneof.
- SimulateScenario.ScenarioOneofCase
Enum of possible cases for the "scenario" oneof.
- SimulationMode
How the simulated user interacts with the agent under test.
- StartEgressRequest.EncodingOneofCase
Enum of possible cases for the "encoding" oneof.
- StartEgressRequest.SourceOneofCase
Enum of possible cases for the "source" oneof.
- StorageConfig.ProviderOneofCase
Enum of possible cases for the "provider" oneof.
- TextMessageComplete.ResultOneofCase
Enum of possible cases for the "result" oneof.
- TextMessageResponse.EventOneofCase
Enum of possible cases for the "event" oneof.
- TrackCompositeEgressRequest.OptionsOneofCase
Enum of possible cases for the "options" oneof.
- TrackCompositeEgressRequest.OutputOneofCase
Enum of possible cases for the "output" oneof.
- TrackEgressRequest.OutputOneofCase
Enum of possible cases for the "output" oneof.
- UpdateSIPDispatchRuleRequest.ActionOneofCase
Enum of possible cases for the "action" oneof.
- UpdateSIPInboundTrunkRequest.ActionOneofCase
Enum of possible cases for the "action" oneof.
- UpdateSIPOutboundTrunkRequest.ActionOneofCase
Enum of possible cases for the "action" oneof.
- WebEgressRequest.OptionsOneofCase
Enum of possible cases for the "options" oneof.
- WebEgressRequest.OutputOneofCase
Enum of possible cases for the "output" oneof.
- WorkerMessage.MessageOneofCase
Enum of possible cases for the "message" oneof.