Modules§
- 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. - data_
packet - Nested message and enum types in
DataPacket. - data_
stream - Nested message and enum types in
DataStream. - debouncer
- direct_
file_ output - Nested message and enum types in
DirectFileOutput. - 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. - enum_
dispatch - 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. - observer
- participant_
egress_ request - Nested message and enum types in
ParticipantEgressRequest. - participant_
info - Nested message and enum types in
ParticipantInfo. - promise
- 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. - 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. - sip_
dispatch_ rule - Nested message and enum types in
SIPDispatchRule. - sip_
trunk_ info - Nested message and enum types in
SIPTrunkInfo. - 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_
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.
Macros§
Structs§
- Active
Speaker Update - AddTrack
Request - Agent
Dispatch - Agent
Dispatch State - AliOss
Upload - Auto
Participant Egress - Auto
Track Egress - Availability
Request - Availability
Response - Azure
Blob Upload - Chat
Message - Client
Configuration - server provided client configuration
- Client
Info - details about the client
- Codec
- Connection
Quality Info - Connection
Quality Update - Connection
Settings - Create
Agent Dispatch Request - Create
Ingress Request - Create
Room Request - Create
SipDispatch Rule Request - Create
SipInbound Trunk Request - Create
SipOutbound Trunk Request - Create
SipParticipant Request - A SIP Participant is a singular SIP session connected to a LiveKit room via a SIP Trunk into a SIP DispatchRule
- Create
SipTrunk Request - Data
Channel Info - Data
Channel Receive State - Data
Packet - new DataPacket API
- Data
Stream - Delete
Agent Dispatch Request - Delete
Ingress Request - Delete
Room Request - Delete
Room Response - Delete
SipDispatch Rule Request - Delete
SipTrunk Request - Direct
File Output - Disabled
Codecs - Egress
Info - Encoded
File Output - Encoding
Options - Encrypted
Packet - Encrypted
Packet Payload - Encryption
- Event
Metric - File
Info - Forward
Participant Request - Forward
Participant Response - GcpUpload
- GetSip
Inbound Trunk Request - GetSip
Inbound Trunk Response - GetSip
Outbound Trunk Request - GetSip
Outbound Trunk Response - IceServer
- Image
Output - Images
Info - Ingress
Audio Encoding Options - Ingress
Audio Options - Ingress
Info - Ingress
State - Ingress
Video Encoding Options - Ingress
Video Options - Input
Audio State - Input
Video State - Job
- JobAssignment
- JobState
- JobTermination
- Join
Request - Join
Response - Leave
Request - List
Agent Dispatch Request - List
Agent Dispatch Response - List
Egress Request - List
Egress Response - List
Ingress Request - List
Ingress Response - List
Participants Request - List
Participants Response - List
Rooms Request - List
Rooms Response - List
SipDispatch Rule Request - ListSIPDispatchRuleRequest lists dispatch rules for given filters. If no filters are set, all rules are listed.
- List
SipDispatch Rule Response - List
SipInbound Trunk Request - ListSIPInboundTrunkRequest lists inbound trunks for given filters. If no filters are set, all trunks are listed.
- List
SipInbound Trunk Response - List
SipOutbound Trunk Request - ListSIPOutboundTrunkRequest lists outbound trunks for given filters. If no filters are set, all trunks are listed.
- List
SipOutbound Trunk Response - List
SipTrunk Request - List
SipTrunk Response - List
Update - ListUpdate is used for updated APIs where ‘repeated string’ field is modified.
- Media
Sections Requirement - Metric
Sample - Metrics
Batch - Migrate
JobRequest - Move
Participant Request - Move
Participant Response - Mute
Room Track Request - Mute
Room Track Response - Mute
Track Request - Pagination
- Participant
Egress Request - record audio and video from a single participant
- Participant
Info - Participant
Permission - Participant
Tracks - Participant
Update - Ping
- Playout
Delay - Pong
- Proxy
Config - Reconnect
Response - Region
Info - Region
Settings - Register
Worker Request - Register
Worker Response - Remove
Participant Response - Request
Response - Room
- Room
Agent - Room
Agent Dispatch - Room
Composite Egress Request - composite using a web browser
- Room
Configuration - Room
Egress - Room
Moved Response - Room
Participant Identity - Room
Update - RpcAck
- RpcError
- RpcRequest
- RpcResponse
- Rtcp
Sender Report State - RtpDrift
- RtpForwarder
State - RtpMunger
State - RtpStats
- S3Upload
- Segmented
File Output - Used to generate HLS segments or other kind of segmented output
- Segments
Info - Send
Data Request - Send
Data Response - Server
Info - details about the server
- Server
Message - from Server to Worker
- Session
Description - Signal
Request - Signal
Response - Simulate
JobRequest - Simulate
Scenario - Simulcast
Codec - Simulcast
Codec Info - SipCall
Info - SipDispatch
Rule - SipDispatch
Rule Callee - SipDispatch
Rule Direct - SipDispatch
Rule Individual - SipDispatch
Rule Info - SipDispatch
Rule Update - SipDtmf
- SipInbound
Trunk Info - SipInbound
Trunk Update - SipOutbound
Config - SipOutbound
Trunk Info - SipOutbound
Trunk Update - SipParticipant
Info - SipStatus
- SIPStatus is returned as an error detail in CreateSIPParticipant.
- SipTransfer
Info - SipTrunk
Info - SipUri
- Speaker
Info - Speakers
Changed - Stop
Egress Request - Stream
Info - Stream
Info List - Stream
Output - Stream
State Info - Stream
State Update - Subscribed
Codec - Subscribed
Quality - Subscribed
Quality Update - Subscription
Permission - Subscription
Permission Update - Subscription
Response - Sync
State - Time
Series Metric - Timed
Version - Token
Pagination - Track
Composite Egress Request - containerize up to one audio and one video track
- Track
Egress Request - record tracks individually, without transcoding
- Track
Info - Track
Permission - Track
Published Response - Track
Subscribed - Track
Unpublished Response - Transcription
- Transcription
Segment - Transfer
SipParticipant Request - Trickle
Request - Update
Ingress Request - Update
JobStatus - Update
Layout Request - Update
Local Audio Track - Update
Local Video Track - Update
Participant Metadata - Update
Participant Request - Update
Room Metadata Request - Update
SipDispatch Rule Request - Update
SipInbound Trunk Request - Update
SipOutbound Trunk Request - Update
Stream Request - Update
Subscription - Update
Subscriptions Request - Update
Subscriptions Response - empty for now
- Update
Track Settings - Update
Video Layers - message to indicate published video track dimensions are changing
- Update
Worker Status - User
Packet - Video
Configuration - Video
Layer - provide information about available spatial layers
- Vp8Munger
State - WebEgress
Request - record any website
- Webhook
Config - Webhook
Event - Worker
Message - from Worker to Server
- Worker
Ping - Worker
Pong - Wrapped
Join Request
Enums§
- Audio
Codec - Audio
Mixing - Audio
Track Feature - Backup
Codec Policy - Policy for publisher to handle subscribers that are unable to support the primary codec of a track
- Candidate
Protocol - Client
Config Setting - Connection
Quality - Disconnect
Reason - Egress
Source Type - Egress
Status - Encoded
File Type - Encoding
Options Preset - Image
Codec - Image
File Suffix - Ingress
Audio Encoding Preset - Ingress
Input - Ingress
Video Encoding Preset - JobStatus
- JobType
- Metric
Label - index from [0: MAX_LABEL_PREDEFINED_MAX_VALUE) are for predefined labels (
MetricLabel) - Reconnect
Reason - Segmented
File Protocol - Segmented
File Suffix - Signal
Target - SipCall
Direction - SipCall
Status - SipFeature
- SipHeader
Options - SipMedia
Encryption - SipStatus
Code - SipTransfer
Status - SipTransport
- Stream
Protocol - Stream
State - Subscription
Error - Track
Source - Track
Type - Video
Codec - Video
Quality - Worker
Status