Skip to main content Crate livekit_protocol Copy item path Source agent The livekit.agent protobuf package: AgentSessionEvent, SessionRequest and the agent
worker/inference messages. Generated by generate_proto.sh; a new package needs its own
include! or the types exist on disk and are reachable from nowhere. agent_db Nested message and enum types in AgentDB. agent_http Nested message and enum types in AgentHttp. api_call_request Nested message and enum types in APICallRequest. audio_route Nested message and enum types in AudioRoute. auto_participant_egress Nested message and enum types in AutoParticipantEgress. auto_track_egress Nested message and enum types in AutoTrackEgress. client_info Nested message and enum types in ClientInfo. connect_twilio_call_request Nested message and enum types in ConnectTwilioCallRequest. create_private_link_request Nested message and enum types in CreatePrivateLinkRequest. data_blob_key Nested message and enum types in DataBlobKey. data_packet Nested message and enum types in DataPacket. data_selector Nested message and enum types in DataSelector. data_stream Nested message and enum types in DataStream. data_track_frame_encoding Nested message and enum types in DataTrackFrameEncoding. data_track_schema_encoding Nested message and enum types in DataTrackSchemaEncoding. data_track_subscriber_handles Nested message and enum types in DataTrackSubscriberHandles. direct_file_output Nested message and enum types in DirectFileOutput. disconnect_whats_app_call_request Nested message and enum types in DisconnectWhatsAppCallRequest. egress_info Nested message and enum types in EgressInfo. encoded_file_output Nested message and enum types in EncodedFileOutput. encrypted_packet_payload Nested message and enum types in EncryptedPacketPayload. encryption Nested message and enum types in Encryption. export_replay_request Nested message and enum types in ExportReplayRequest. feature_usage_info Nested message and enum types in FeatureUsageInfo. image_output Nested message and enum types in ImageOutput. ingress_audio_options Nested message and enum types in IngressAudioOptions. ingress_state Nested message and enum types in IngressState. ingress_video_options Nested message and enum types in IngressVideoOptions. leave_request Nested message and enum types in LeaveRequest. logger The logger protobuf package: the Sensitivity field annotation enum. media_source Nested message and enum types in MediaSource. output Nested message and enum types in Output. participant_egress_request Nested message and enum types in ParticipantEgressRequest. participant_info Nested message and enum types in ParticipantInfo. private_link Nested message and enum types in PrivateLink. private_link_status Nested message and enum types in PrivateLinkStatus. report_info Nested message and enum types in ReportInfo. request_response Nested message and enum types in RequestResponse. room_composite_egress_request Nested message and enum types in RoomCompositeEgressRequest. rpc_response Nested message and enum types in RpcResponse. rtp_forwarder_state Nested message and enum types in RTPForwarderState. scenario Nested message and enum types in Scenario. segmented_file_output Nested message and enum types in SegmentedFileOutput. server_info Nested message and enum types in ServerInfo. server_message Nested message and enum types in ServerMessage. signal_request Nested message and enum types in SignalRequest. signal_response Nested message and enum types in SignalResponse. simulate_scenario Nested message and enum types in SimulateScenario. simulation_run Nested message and enum types in SimulationRun. simulation_run_summary Nested message and enum types in SimulationRunSummary. sip_dispatch_rule Nested message and enum types in SIPDispatchRule. sip_named_dest Nested message and enum types in SIPNamedDest. sip_request_dest Nested message and enum types in SIPRequestDest. sip_trunk_info Nested message and enum types in SIPTrunkInfo. start_egress_request Nested message and enum types in StartEgressRequest. storage_config Nested message and enum types in StorageConfig. stream_info Nested message and enum types in StreamInfo. track_composite_egress_request Nested message and enum types in TrackCompositeEgressRequest. track_egress_request Nested message and enum types in TrackEgressRequest. update_data_subscription Nested message and enum types in UpdateDataSubscription. update_sip_dispatch_rule_request Nested message and enum types in UpdateSIPDispatchRuleRequest. update_sip_inbound_trunk_request Nested message and enum types in UpdateSIPInboundTrunkRequest. update_sip_outbound_trunk_request Nested message and enum types in UpdateSIPOutboundTrunkRequest. video_layer Nested message and enum types in VideoLayer. web_egress_request Nested message and enum types in WebEgressRequest. worker_message Nested message and enum types in WorkerMessage. wrapped_join_request Nested message and enum types in WrappedJoinRequest. AcceptWhatsAppCallRequest AcceptWhatsAppCallResponse ActiveSpeakerUpdate AddTrackRequest AgentDb Nested so that names like Value and Ping need not be unique across the
livekit package. tip throughout is the latest durable commit sequence. AgentDeployment AgentDispatch AgentDispatchState AgentEvent AgentHttp —– agent HTTP endpoints data plane —– AgentInfo AgentSecret AgentVersion AliOssUpload AnalyticsClientMeta AnalyticsEvent AnalyticsEvents AnalyticsNodeRooms AnalyticsRoom AnalyticsRoomParticipant AnalyticsStat AnalyticsStats AnalyticsStream AnalyticsVideoLayer ApiCallInfo ApiCallRequest AudioConfig Unified audio selection and channel routing.
Each route specifies both which audio to capture and which channel to output to. AudioRoute AutoParticipantEgress AutoTrackEgress AvailabilityRequest AvailabilityResponse AzureBlobUpload ChatMessage ClientConfiguration server provided client configuration ClientInfo details about the client ClientSettingsRequest ClientSettingsResponse ClosePlaybackRequest Codec ConnectTwilioCallRequest ConnectTwilioCallResponse ConnectWhatsAppCallRequest ConnectWhatsAppCallResponse ConnectionQualityInfo ConnectionQualityUpdate ConnectionSettings CreateAgentDispatchRequest CreateAgentRequest CreateAgentResponse CreateAgentV2Request CreateAgentV2Response CreateIngressRequest CreatePrivateLinkRequest CreatePrivateLinkResponse CreateRoomRequest CreateSipDispatchRuleRequest CreateSipInboundTrunkRequest CreateSipOutboundTrunkRequest CreateSipParticipantRequest A SIP Participant is a singular SIP session connected to a LiveKit room via
a SIP Trunk into a SIP DispatchRule CreateSipTrunkRequest 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. DataChannelInfo DataChannelReceiveState DataConfig DataPacket new DataPacket API DataSelector DataStream DataTrackExtensionParticipantSid DataTrackFrameEncoding Encoding for frame payloads. DataTrackInfo DataTrackSchemaEncoding Encoding for schema definition. DataTrackSchemaId Identifier for a data track schema. DataTrackSubscriberHandles DataTrackSubscriptionOptions DeleteAgentDispatchRequest DeleteAgentRequest DeleteAgentResponse DeleteIngressRequest DeleteReplayRequest DeleteRoomRequest DeleteRoomResponse DeleteSipDispatchRuleRequest DeleteSipTrunkRequest DependencyDescriptorForwarderState State of a forwarder that writes the dependency descriptor for the subscriber, so
its frame numbers continue on a migrated subscriber. DeployAgentRequest DeployAgentResponse DeployAgentV2Request DeployAgentV2Response Destination DestroyPrivateLinkRequest DestroyPrivateLinkResponse DialWhatsAppCallRequest DialWhatsAppCallResponse DirectFileOutput DisabledCodecs DisconnectWhatsAppCallRequest DisconnectWhatsAppCallResponse EgressInfo EncodedFileOutput EncodingOptions EncryptedPacket EncryptedPacketPayload Encryption EndCallV1Request EndCallV1Response EventMetric ExportReplayRequest FeatureUsageInfo FileInfo FileOutput Unified file output — replaces v1 EncodedFileOutput and DirectFileOutput.
Whether transcoded depends on encoding options on the request. FilterParams ForwardParticipantRequest ForwardParticipantResponse GcpUpload GetDataBlobRequest GetDataBlobResponse GetPhoneNumberRequest GetPhoneNumberRequest - Request to get a phone number GetPhoneNumberResponse GetPhoneNumberResponse - Response containing the phone number GetPrivateLinkStatusRequest GetPrivateLinkStatusResponse GetRemoteHeadersV1Request GetRemoteHeadersV1Response GetSipInboundTrunkRequest GetSipInboundTrunkResponse GetSipOutboundTrunkRequest GetSipOutboundTrunkResponse IceConfig IceServer ImageOutput Capture images at a specified interval ImagesInfo IngressAudioEncodingOptions IngressAudioOptions IngressInfo IngressState IngressVideoEncodingOptions IngressVideoOptions InputAudioState InputVideoState Job JobAssignment JobState JobTermination JoinRequest JoinResponse LeaveRequest ListAgentDispatchRequest ListAgentDispatchResponse ListAgentSecretsRequest ListAgentSecretsResponse ListAgentVersionsRequest ListAgentVersionsResponse ListAgentsRequest ListAgentsResponse ListEgressRequest ListEgressResponse ListIngressRequest ListIngressResponse ListParticipantsRequest ListParticipantsResponse ListPhoneNumbersRequest ListPhoneNumbersRequest - Request to list phone numbers ListPhoneNumbersResponse ListPhoneNumbersResponse - Response containing phone numbers ListPrivateLinksRequest ListPrivateLinksResponse ListReplaysRequest ListReplaysResponse ListRoomsRequest ListRoomsResponse ListSipDispatchRuleRequest ListSIPDispatchRuleRequest lists dispatch rules for given filters. If no filters are set, all rules are listed. ListSipDispatchRuleResponse ListSipInboundTrunkRequest ListSIPInboundTrunkRequest lists inbound trunks for given filters. If no filters are set, all trunks are listed. ListSipInboundTrunkResponse ListSipOutboundTrunkRequest ListSIPOutboundTrunkRequest lists outbound trunks for given filters. If no filters are set, all trunks are listed. ListSipOutboundTrunkResponse ListSipTrunkRequest ListSipTrunkResponse ListUpdate ListUpdate is used for updated APIs where ‘repeated string’ field is modified. MediaSectionsRequirement MediaSource Capture tracks directly from a room via SDK.
Unifies deprecated Participant, TrackComposite, and Track egress. MetricSample MetricsBatch MetricsRecordingHeader MigrateJobRequest MoveParticipantRequest MoveParticipantResponse MuteRoomTrackRequest MuteRoomTrackResponse MuteTrackRequest Node NodeStats NodeStatsRate rates of different node stats (per second) Output Pagination ParticipantEgressRequest ParticipantInfo ParticipantPermission ParticipantTracks ParticipantUpdate ParticipantVideo PerformRpcRequest PerformRpcResponse PhoneNumber PhoneNumber - Unified phone number type for inventory and purchased numbers Ping PlaybackRequest PlaybackResponse PlayoutDelay Pong PresignedPostRequest PrivateLink PrivateLinkStatus PromoteAgentRequest PromoteAgentResponse ProviderInfo ProxyConfig PublishDataTrackRequest PublishDataTrackResponse PurchasePhoneNumberRequest PurchasePhoneNumberRequest - Request to purchase phone numbers PurchasePhoneNumberResponse PurchasePhoneNumberResponse - Response containing the purchased phone numbers ReconnectResponse RegionInfo RegionSettings RegisterWorkerRequest RegisterWorkerResponse ReleasePhoneNumbersRequest ReleasePhoneNumbersRequest - Request to release phone numbers ReleasePhoneNumbersResponse ReleasePhoneNumbersResponse - Response for releasing phone numbers RemoveParticipantResponse ReplayInfo ReportInfo RequestResponse RestartAgentRequest RestartAgentResponse RollbackAgentRequest RollbackAgentResponse Room RoomAgent RoomAgentDispatch RoomCompositeEgressRequest RoomConfiguration RoomEgress RoomInternal room info that should not be returned to clients RoomMovedResponse RoomParticipantIdentity RoomUpdate RpcAck RpcError RpcRequest RpcResponse RtcpSenderReportState RtpDrift RtpForwarderState RtpMungerState RtpStats S3Upload 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. 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 SeekRequest SegmentedFileOutput Used to generate HLS segments or other kind of segmented output SegmentsInfo SendDataRequest SendDataResponse ServerInfo details about the server ServerMessage from Server to Worker SessionDescription SettingsParam SignalRequest SignalResponse SimulateJobRequest SimulateScenario 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 SimulationRunSummary SimulcastCodec SimulcastCodecInfo SipCallInfo SipCodec SipDispatchRule SipDispatchRuleCallee SipDispatchRuleDirect SipDispatchRuleIndividual SipDispatchRuleInfo SipDispatchRuleUpdate SipDtmf SipInboundTrunkInfo SipInboundTrunkUpdate SipMediaConfig SipNamedDest SipOutboundConfig SipOutboundTrunkInfo SipOutboundTrunkUpdate SipParticipantInfo SipRequestDest SipStatus SIPStatus is returned as an error detail in CreateSIPParticipant. SipTransferError Details of a failed SIP transfer, attached to the error. SipTransferInfo SipTrunkInfo SipUri SpeakerInfo SpeakersChanged StartEgressRequest StartSession StopEgressRequest StorageConfig StoreDataBlobRequest StoreDataBlobResponse StreamInfo StreamInfoList StreamOutput StreamStateInfo StreamStateUpdate SubscribedAudioCodec SubscribedAudioCodecUpdate SubscribedCodec SubscribedQuality SubscribedQualityUpdate SubscriptionPermission SubscriptionPermissionUpdate SubscriptionResponse SyncState TemplateSource Room composite recording via layout template.
Service generates token, constructs recorder URL, awaits start signal. TimeRange TimeSeriesMetric TimedVersion TokenPagination TokenSourceRequest TokenSourceResponse TrackCompositeEgressRequest TrackEgressRequest TrackInfo TrackPermission TrackPublishedResponse TrackSubscribed TrackUnpublishedResponse Transcription TranscriptionSegment TransferSipParticipantRequest 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. TrickleRequest UnpublishDataTrackRequest UnpublishDataTrackResponse UpdateAgentRequest UpdateAgentResponse UpdateAgentSecretsRequest UpdateAgentSecretsResponse UpdateDataSubscription UpdateIngressRequest UpdateJobStatus UpdateLayoutRequest UpdateLocalAudioTrack UpdateLocalVideoTrack UpdateParticipantMetadata UpdateParticipantRequest UpdatePhoneNumberRequest UpdatePhoneNumberRequest - Request to update a phone number UpdatePhoneNumberResponse UpdatePhoneNumberResponse - Response containing the updated phone number UpdateRoomMetadataRequest UpdateSipDispatchRuleRequest UpdateSipInboundTrunkRequest UpdateSipOutboundTrunkRequest UpdateStreamRequest UpdateSubscription UpdateSubscriptionsRequest UpdateSubscriptionsResponse empty for now UpdateTrackSettings UpdateVideoLayers message to indicate published video track dimensions are changing UpdateWorkerStatus UserPacket VideoConfiguration VideoLayer provide information about available spatial layers Vp8MungerState WebEgressRequest WebSource Record a custom URL via headless browser. WebhookConfig WebhookEvent WebhookInfo WhatsAppCall WorkerInfo WorkerMessage from Worker to Server WorkerPing WorkerPong WrappedJoinRequest AgentEventType AgentSecretKind AnalyticsEventType AudioChannel AudioCodec AudioMixing AudioTrackFeature BackupCodecPolicy Policy for publisher to handle subscribers that are unable to support the primary codec of a track CandidateProtocol ClientConfigSetting ConnectionQuality ConnectorType DataTrackExtensionId DisconnectReason EgressSourceType EgressStatus EncodedFileType EncodingOptionsPreset IceCandidateType ImageCodec ImageFileSuffix IngressAudioEncodingPreset IngressInput IngressVideoEncodingPreset JobRestartPolicy JobStatus JobType MetricLabel index from [0: MAX_LABEL_PREDEFINED_MAX_VALUE) are for predefined labels (MetricLabel) NodeState NodeType PacketTrailerFeature PhoneNumberInboundStatus PhoneNumberOutboundStatus PhoneNumberStatus Phone number status enumeration PhoneNumberType Phone number type enumeration ProviderType ReconnectReason RoomEndReason why a room ended, reported on room-ended telemetry SegmentedFileProtocol SegmentedFileSuffix SignalTarget SimulationMode How the simulated user interacts with the agent under test. SipCallDirection SipCallStatus SipFeature SipHeaderOptions SipMediaEncryption SipStatusCode SipTransferReason SipTransferStatus SipTransport StreamProtocol StreamState StreamType SubscriptionError TrackSource TrackType VideoCodec VideoQuality WhatsAppCallDirection WorkerStatus