package livekit

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc IngestStats (stream AnalyticsStats, google.protobuf.Empty)

  livekit_analytics.proto:15

  message AnalyticsStats

  livekit_analytics.proto:63

  • repeated AnalyticsStat stats = 1

• rpc IngestEvents (stream AnalyticsEvents, google.protobuf.Empty)

  livekit_analytics.proto:16

  message AnalyticsEvents

  livekit_analytics.proto:116

  • repeated AnalyticsEvent events = 1

• rpc StartRoomCompositeEgress (RoomCompositeEgressRequest, EgressInfo)

  livekit_egress.proto:10

  start recording or streaming a room, participant, or tracks

• rpc StartTrackCompositeEgress (TrackCompositeEgressRequest, EgressInfo)

  livekit_egress.proto:11

• rpc StartTrackEgress (TrackEgressRequest, EgressInfo)

  livekit_egress.proto:12

• rpc UpdateLayout (UpdateLayoutRequest, EgressInfo)

  livekit_egress.proto:15

  update web composite layout

  message UpdateLayoutRequest

  livekit_egress.proto:179

  • string egress_id = 1

  • string layout = 2

• rpc UpdateStream (UpdateStreamRequest, EgressInfo)

  livekit_egress.proto:18

  add or remove stream endpoints

• rpc ListEgress (ListEgressRequest, ListEgressResponse)

  livekit_egress.proto:21

  list available egress

  message ListEgressRequest

  livekit_egress.proto:190

  • string room_name = 1

    (optional, used to filter results)

  message ListEgressResponse

  livekit_egress.proto:194

  • repeated EgressInfo items = 1

• rpc StopEgress (StopEgressRequest, EgressInfo)

  livekit_egress.proto:24

  stop a recording or stream

• rpc CreateIngress (CreateIngressRequest, IngressInfo)

  livekit_ingress.proto:13

  Create a new Ingress

  message CreateIngressRequest

  livekit_ingress.proto:20

  • IngressInput input_type = 1

  • string name = 2

    User provided identifier for the ingress

  • string room_name = 3

    room to publish to

  • string participant_identity = 4

    publish as participant

  • string participant_name = 5

    name of publishing participant (used for display only)

  • optional IngressAudioOptions audio = 6

  • optional IngressVideoOptions video = 7

• rpc UpdateIngress (UpdateIngressRequest, IngressInfo)

  livekit_ingress.proto:15

  Update an existing Ingress. Ingress can only be updated when it's in ENDPOINT_WAITING state.

• rpc ListIngress (ListIngressRequest, ListIngressResponse)

  livekit_ingress.proto:16

  message ListIngressRequest

  livekit_ingress.proto:123

  • string room_name = 1

    when blank, lists all ingress endpoints

  message ListIngressResponse

  livekit_ingress.proto:128

  • repeated IngressInfo items = 1

• rpc DeleteIngress (DeleteIngressRequest, IngressInfo)

  livekit_ingress.proto:17

Room service that can be performed on any node they are Twirp-based HTTP req/responses

• rpc CreateRoom (CreateRoomRequest, Room)

  livekit_room.proto:16

  Creates a room with settings. Requires `roomCreate` permission. This method is optional; rooms are automatically created when clients connect to them for the first time.

  message CreateRoomRequest

  livekit_room.proto:50

  • string name = 1

    name of the room

  • uint32 empty_timeout = 2

    number of seconds to keep the room open if no one joins

  • uint32 max_participants = 3

    limit number of participants that can be in a room

  • string node_id = 4

    override the node room is allocated to, for debugging

  • string metadata = 5

    metadata of room

  • optional RoomEgress egress = 6

    egress

• rpc ListRooms (ListRoomsRequest, ListRoomsResponse)

  livekit_room.proto:19

  List rooms that are active on the server. Requires `roomList` permission.

  message ListRoomsRequest

  livekit_room.proto:70

  • repeated string names = 1

    when set, will only return rooms with name match

  message ListRoomsResponse

  livekit_room.proto:75

  • repeated Room rooms = 1

• rpc DeleteRoom (DeleteRoomRequest, DeleteRoomResponse)

  livekit_room.proto:23

  Deletes an existing room by name or id. Requires `roomCreate` permission. DeleteRoom will disconnect all participants that are currently in the room.

  message DeleteRoomResponse

  livekit_room.proto:84

  (message has no fields)

• rpc ListParticipants (ListParticipantsRequest, ListParticipantsResponse)

  livekit_room.proto:26

  Lists participants in a room, Requires `roomAdmin`

  message ListParticipantsRequest

  livekit_room.proto:87

  • string room = 1

    name of the room

  message ListParticipantsResponse

  livekit_room.proto:92

  • repeated ParticipantInfo participants = 1

• rpc GetParticipant (RoomParticipantIdentity, ParticipantInfo)

  livekit_room.proto:29

  Get information on a specific participant, Requires `roomAdmin`

• rpc RemoveParticipant (RoomParticipantIdentity, RemoveParticipantResponse)

  livekit_room.proto:32

  Removes a participant from room. Requires `roomAdmin`

  message RemoveParticipantResponse

  livekit_room.proto:103

  (message has no fields)

• rpc MutePublishedTrack (MuteRoomTrackRequest, MuteRoomTrackResponse)

  livekit_room.proto:35

  Mute/unmute a participant's track, Requires `roomAdmin`

  message MuteRoomTrackResponse

  livekit_room.proto:116

  • optional TrackInfo track = 1

• rpc UpdateParticipant (UpdateParticipantRequest, ParticipantInfo)

  livekit_room.proto:38

  Update participant metadata, will cause updates to be broadcasted to everyone in the room. Requires `roomAdmin`

• rpc UpdateSubscriptions (UpdateSubscriptionsRequest, UpdateSubscriptionsResponse)

  livekit_room.proto:41

  Subscribes or unsubscribe a participant from tracks. Requires `roomAdmin`

  message UpdateSubscriptionsResponse

  livekit_room.proto:140

  empty for now

  (message has no fields)

• rpc SendData (SendDataRequest, SendDataResponse)

  livekit_room.proto:44

  Send data over data channel to participants in a room, Requires `roomAdmin`

  message SendDataResponse

  livekit_room.proto:151

  (message has no fields)

• rpc UpdateRoomMetadata (UpdateRoomMetadataRequest, Room)

  livekit_room.proto:47

  Update room metadata, will cause updates to be broadcasted to everyone in the room, Requires `roomAdmin`

Used in: DataPacket

• repeated SpeakerInfo speakers = 1

Used in: SignalRequest

• string cid = 1

  client ID of track, to match it when RTC track is received

• string name = 2

• TrackType type = 3

• uint32 width = 4

  to be deprecated in favor of layers

• uint32 height = 5

• bool muted = 6

  true to add track and initialize to muted

• bool disable_dtx = 7

  true if DTX (Discontinuous Transmission) is disabled for audio

• TrackSource source = 8

• repeated VideoLayer layers = 9

• repeated SimulcastCodec simulcast_codecs = 10

• string sid = 11

  server ID of track, publish new codec to exist track

Used in: AnalyticsEvent

• string region = 1

• string node = 2

• string client_addr = 3

• uint32 client_connect_time = 4

• string connection_type = 5

  udp, tcp, turn

Used in: AnalyticsEvents

• AnalyticsEventType type = 1

• optional google.protobuf.Timestamp timestamp = 2

• string room_id = 3

• optional Room room = 4

• string participant_id = 5

• optional ParticipantInfo participant = 6

• string track_id = 7

• optional TrackInfo track = 8

• string analytics_key = 10

• optional ClientInfo client_info = 11

• optional AnalyticsClientMeta client_meta = 12

• string egress_id = 13

• VideoQuality max_subscribed_video_quality = 14

• optional ParticipantInfo publisher = 15

• string mime = 16

• optional EgressInfo egress = 17

• optional IngressInfo ingress = 18

Used in: AnalyticsEvent

• ROOM_CREATED = 0

• ROOM_ENDED = 1

• PARTICIPANT_JOINED = 2

• PARTICIPANT_LEFT = 3

• TRACK_PUBLISHED = 4

• TRACK_UNPUBLISHED = 5

• TRACK_SUBSCRIBED = 6

• TRACK_UNSUBSCRIBED = 7

• TRACK_PUBLISHED_UPDATE = 10

• PARTICIPANT_ACTIVE = 11

• EGRESS_STARTED = 12

• EGRESS_ENDED = 13

• TRACK_MAX_SUBSCRIBED_VIDEO_QUALITY = 14

• RECONNECTED = 15

• INGRESS_STARTED = 16

• INGRESS_ENDED = 17

Used in: AnalyticsStats

• string analytics_key = 1

• StreamType kind = 2

• optional google.protobuf.Timestamp time_stamp = 3

• string node = 4

• string room_id = 5

• string room_name = 6

• string participant_id = 7

• string track_id = 8

• float score = 9

• repeated AnalyticsStream streams = 10

• string mime = 11

Used in: AnalyticsStat

• uint32 ssrc = 1

• uint32 primary_packets = 2

• uint64 primary_bytes = 3

• uint32 retransmit_packets = 4

• uint64 retransmit_bytes = 5

• uint32 padding_packets = 6

• uint64 padding_bytes = 7

• uint32 packets_lost = 8

• uint32 frames = 9

• uint32 rtt = 10

• uint32 jitter = 11

• uint32 nacks = 12

• uint32 plis = 13

• uint32 firs = 14

• repeated AnalyticsVideoLayer video_layers = 15

Used in: AnalyticsStream

• int32 layer = 1

• uint32 packets = 2

• uint64 bytes = 3

• uint32 frames = 4

Used in: EncodingOptions

• DEFAULT_AC = 0

• OPUS = 1

• AAC = 2

Used in: RoomEgress, RoomInternal

• string file_prefix = 1

• oneof output

  • S3Upload s3 = 2

  • GCPUpload gcp = 3

  • AzureBlobUpload azure = 4

Used in: AutoTrackEgress, DirectFileOutput, EncodedFileOutput, SegmentedFileOutput

• string account_name = 1

• string account_key = 2

• string container_name = 3

Used in: SimulateScenario

• UDP = 0

• TCP = 1

• TLS = 2

Used in: ClientConfiguration, VideoConfiguration

• UNSET = 0

• DISABLED = 1

• ENABLED = 2

server provided client configuration

Used in: JoinResponse

• optional VideoConfiguration video = 1

• optional VideoConfiguration screen = 2

• ClientConfigSetting resume_connection = 3

• optional DisabledCodecs disabled_codecs = 4

• ClientConfigSetting force_relay = 5

details about the client

Used in: AnalyticsEvent, StartSession

• ClientInfo.SDK sdk = 1

• string version = 2

• int32 protocol = 3

• string os = 4

• string os_version = 5

• string device_model = 6

• string browser = 7

• string browser_version = 8

• string address = 9

• string network = 10

  wifi, wired, cellular, vpn, empty if not known

Used in: ClientInfo

• UNKNOWN = 0

• JS = 1

• SWIFT = 2

• ANDROID = 3

• FLUTTER = 4

• GO = 5

• UNITY = 6

Used in: DisabledCodecs, Room

• string mime = 1

• string fmtp_line = 2

Used in: ConnectionQualityInfo

• POOR = 0

• GOOD = 1

• EXCELLENT = 2

Used in: ConnectionQualityUpdate

• string participant_sid = 1

• ConnectionQuality quality = 2

• float score = 3

Used in: SignalResponse

• repeated ConnectionQualityInfo updates = 1

Used in: SyncState

• string label = 1

• uint32 id = 2

• SignalTarget target = 3

new DataPacket API

• DataPacket.Kind kind = 1

• oneof value

  • UserPacket user = 2

  • ActiveSpeakerUpdate speaker = 3

Used in: DataPacket, SendDataRequest

• RELIABLE = 0

• LOSSY = 1

Used as request type in: Ingress.DeleteIngress

Used as field type in: IngressRequest

• string ingress_id = 1

Used as request type in: RoomService.DeleteRoom

Used as field type in: RTCNodeMessage

• string room = 1

  name of the room

Used in: TrackEgressRequest

• string filepath = 1

  (optional)

• oneof output

  required

  • S3Upload s3 = 2

  • GCPUpload gcp = 3

  • AzureBlobUpload azure = 4

Used in: ClientConfiguration

• repeated Codec codecs = 1

Used in: LeaveRequest

• UNKNOWN_REASON = 0

• CLIENT_INITIATED = 1

• DUPLICATE_IDENTITY = 2

• SERVER_SHUTDOWN = 3

• PARTICIPANT_REMOVED = 4

• ROOM_DELETED = 5

• STATE_MISMATCH = 6

• JOIN_FAILURE = 7

Used as response type in: Egress.StartRoomCompositeEgress, Egress.StartTrackCompositeEgress, Egress.StartTrackEgress, Egress.StopEgress, Egress.UpdateLayout, Egress.UpdateStream

Used as field type in: AnalyticsEvent, EgressResponse, ListEgressResponse, WebhookEvent

• string egress_id = 1

• string room_id = 2

• string room_name = 13

• EgressStatus status = 3

• int64 started_at = 10

• int64 ended_at = 11

• string error = 9

• oneof request

  • RoomCompositeEgressRequest room_composite = 4

  • TrackCompositeEgressRequest track_composite = 5

  • TrackEgressRequest track = 6

• oneof result

  • StreamInfoList stream = 7

  • FileInfo file = 8

  • SegmentsInfo segments = 12

• string egress_id = 1

  request metadata

• string request_id = 2

• string sender_id = 5

• oneof request

  request

  • UpdateStreamRequest update_stream = 3

  • StopEgressRequest stop = 4

• optional EgressInfo info = 1

• string error = 2

• string request_id = 3

Used in: EgressInfo

• EGRESS_STARTING = 0

• EGRESS_ACTIVE = 1

• EGRESS_ENDING = 2

• EGRESS_COMPLETE = 3

• EGRESS_FAILED = 4

• EGRESS_ABORTED = 5

• EGRESS_LIMIT_REACHED = 6

Used in: RoomCompositeEgressRequest, TrackCompositeEgressRequest

• EncodedFileType file_type = 1

  (optional)

• string filepath = 2

  (optional)

• oneof output

  required

  • S3Upload s3 = 3

  • GCPUpload gcp = 4

  • AzureBlobUpload azure = 5

Used in: EncodedFileOutput

• DEFAULT_FILETYPE = 0

  file type chosen based on codecs

• MP4 = 1

• OGG = 2

Used in: RoomCompositeEgressRequest, TrackCompositeEgressRequest

• int32 width = 1

  (default 1920)

• int32 height = 2

  (default 1080)

• int32 depth = 3

  (default 24)

• int32 framerate = 4

  (default 30)

• AudioCodec audio_codec = 5

  (default OPUS)

• int32 audio_bitrate = 6

  (default 128)

• int32 audio_frequency = 7

  (default 44100)

• VideoCodec video_codec = 8

  (default H264_MAIN)

• int32 video_bitrate = 9

  (default 4500)

Used in: RoomCompositeEgressRequest, TrackCompositeEgressRequest

• H264_720P_30 = 0

  1280x720, 30fps, 3000kpbs, H.264_MAIN / OPUS

• H264_720P_60 = 1

  1280x720, 60fps, 4500kbps, H.264_MAIN / OPUS

• H264_1080P_30 = 2

  1920x1080, 30fps, 4500kbps, H.264_MAIN / OPUS

• H264_1080P_60 = 3

  1920x1080, 60fps, 6000kbps, H.264_MAIN / OPUS

• PORTRAIT_H264_720P_30 = 4

  720x1280, 30fps, 3000kpbs, H.264_MAIN / OPUS

• PORTRAIT_H264_720P_60 = 5

  720x1280, 60fps, 4500kbps, H.264_MAIN / OPUS

• PORTRAIT_H264_1080P_30 = 6

  1080x1920, 30fps, 4500kbps, H.264_MAIN / OPUS

• PORTRAIT_H264_1080P_60 = 7

  1080x1920, 60fps, 6000kbps, H.264_MAIN / OPUS

Used in: SignalNodeMessage

(message has no fields)

Used in: EgressInfo

• string filename = 1

• int64 duration = 6

• int64 size = 4

• string location = 5

Used in: AutoTrackEgress, DirectFileOutput, EncodedFileOutput, SegmentedFileOutput

• bytes credentials = 1

• string bucket = 2

Query an ingress info from an ingress ID or stream key

• string ingress_id = 1

• string stream_key = 2

• string request_id = 3

• string sender_id = 4

• int64 sent_at = 5

• optional IngressInfo info = 1

• string token = 2

• string ws_url = 3

• string error = 4

• string request_id = 5

Used in: JoinResponse

• repeated string urls = 1

• string username = 2

• string credential = 3

Used in: CreateIngressRequest, IngressInfo, UpdateIngressRequest

• string name = 1

• TrackSource source = 2

• string mime_type = 3

  desired mime_type to publish to room

• uint32 bitrate = 4

• bool disable_dtx = 5

• uint32 channels = 6

Used as response type in: Ingress.CreateIngress, Ingress.DeleteIngress, Ingress.UpdateIngress

Used as field type in: AnalyticsEvent, GetIngressInfoResponse, IngressResponse, ListIngressResponse, WebhookEvent

• string ingress_id = 1

• string name = 2

• string stream_key = 3

• string url = 4

• IngressInput input_type = 5

  for RTMP input, it'll be a rtmp:// URL for FILE input, it'll be a http:// URL for SRT input, it'll be a srt:// URL

• optional IngressAudioOptions audio = 6

• optional IngressVideoOptions video = 7

• string room_name = 8

• string participant_identity = 9

• string participant_name = 10

• bool reusable = 11

• optional IngressState state = 12

  Description of error/stream non compliance and debug info for publisher otherwise (received bitrate, resolution, bandwidth)

Used in: CreateIngressRequest, IngressInfo

• RTMP_INPUT = 0

  FILE_INPUT = 1; SRT_INPUT = 2; URL_INPUT = 3;

• string ingress_id = 1

  request metadata

• string request_id = 2

• string sender_id = 3

• oneof request

  • UpdateIngressRequest update = 4

  • DeleteIngressRequest delete = 5

• optional IngressInfo info = 1

• string error = 2

• string request_id = 3

Used in: IngressInfo

• IngressState.Status status = 1

• string error = 2

  Error/non compliance description if any

• optional InputVideoState video = 3

• optional InputAudioState audio = 4

• string room_id = 5

  ID of the current/previous room published to

• int64 started_at = 7

• repeated TrackInfo tracks = 6

Used in: IngressState

• ENDPOINT_INACTIVE = 0

• ENDPOINT_BUFFERING = 1

• ENDPOINT_PUBLISHING = 2

• ENDPOINT_ERROR = 3

Used in: CreateIngressRequest, IngressInfo, UpdateIngressRequest

• string name = 1

• TrackSource source = 2

• string mime_type = 3

  desired mime_type to publish to room

• repeated VideoLayer layers = 4

  simulcast layers to publish, when empty, it'll pick default simulcast layers at 1/2 and 1/4 of the dimensions

Used in: IngressState

• uint32 mime_type = 1

• uint32 channels = 3

  uint32 bitrate = 2;

• uint32 sample_rate = 4

Used in: IngressState

• uint32 mime_type = 1

• uint32 width = 3

  uint32 bitrate = 2;

• uint32 height = 4

• uint32 framerate = 5

Used in: SignalResponse

• optional Room room = 1

• optional ParticipantInfo participant = 2

• repeated ParticipantInfo other_participants = 3

• string server_version = 4

  deprecated. use server_info.version instead.

• repeated ICEServer ice_servers = 5

• bool subscriber_primary = 6

  use subscriber as the primary PeerConnection

• string alternative_url = 7

  when the current server isn't available, return alternate url to retry connection when this is set, the other fields will be largely empty

• optional ClientConfiguration client_configuration = 8

• string server_region = 9

  deprecated. use server_info.region instead.

• int32 ping_timeout = 10

• int32 ping_interval = 11

• optional ServerInfo server_info = 12

Used in: RTCNodeMessage

(message has no fields)

Used in: SignalRequest, SignalResponse

• bool can_reconnect = 1

  sent when server initiates the disconnect due to server-restart indicates clients should attempt full-reconnect sequence

• DisconnectReason reason = 2

Used as request type in: RoomService.MutePublishedTrack

Used as field type in: RTCNodeMessage

• string room = 1

  name of the room

• string identity = 2

• string track_sid = 3

  sid of the track to mute

• bool muted = 4

  set to true to mute, false to unmute

Used in: SignalRequest, SignalResponse

• string sid = 1

• bool muted = 2

• string id = 1

• string ip = 2

• uint32 num_cpus = 3

• optional NodeStats stats = 4

• NodeType type = 5

• NodeState state = 6

• string region = 7

Used in: Node

• STARTING_UP = 0

• SERVING = 1

• SHUTTING_DOWN = 2

Used in: Node

• int64 started_at = 1

  when server was started

• int64 updated_at = 2

  when server last reported its status

• int32 num_rooms = 3

  room

• int32 num_clients = 4

• int32 num_tracks_in = 5

• int32 num_tracks_out = 6

• uint64 bytes_in = 7

  packet

• uint64 bytes_out = 8

• uint64 packets_in = 9

• uint64 packets_out = 10

• uint64 nack_total = 11

• float bytes_in_per_sec = 12

• float bytes_out_per_sec = 13

• float packets_in_per_sec = 14

• float packets_out_per_sec = 15

• float nack_per_sec = 16

• uint32 num_cpus = 17

  system

• float load_avg_last1min = 18

• float load_avg_last5min = 19

• float load_avg_last15min = 20

• float cpu_load = 21

• uint32 sys_packets_out = 28

• uint32 sys_packets_dropped = 29

• float sys_packets_out_per_sec = 30

• float sys_packets_dropped_per_sec = 31

• float sys_packets_dropped_pct_per_sec = 32

• uint64 retransmit_bytes_out = 22

  retransmissions

• uint64 retransmit_packets_out = 23

• float retransmit_bytes_out_per_sec = 24

• float retransmit_packets_out_per_sec = 25

• uint64 participant_join = 26

  participant joins

• float participant_join_per_sec = 27

Used in: Node

• SERVER = 0

• CONTROLLER = 1

• MEDIA = 2

• TURN = 4

Used as response type in: RoomService.GetParticipant, RoomService.UpdateParticipant

Used as field type in: AnalyticsEvent, JoinResponse, ListParticipantsResponse, ParticipantUpdate, WebhookEvent

• string sid = 1

• string identity = 2

• ParticipantInfo.State state = 3

• repeated TrackInfo tracks = 4

• string metadata = 5

• int64 joined_at = 6

  timestamp when participant joined room, in seconds

• string name = 9

• uint32 version = 10

• optional ParticipantPermission permission = 11

• string region = 12

• bool is_publisher = 13

  indicates the participant has an active publisher connection and can publish to the server

Used in: ParticipantInfo

• JOINING = 0

  websocket' connected, but not offered yet

• JOINED = 1

  server received client offer

• ACTIVE = 2

  ICE connectivity established

• DISCONNECTED = 3

  WS disconnected

Used in: ParticipantInfo, UpdateParticipantRequest

• bool can_subscribe = 1

  allow participant to subscribe to other tracks in the room

• bool can_publish = 2

  allow participant to publish new tracks to room

• bool can_publish_data = 3

  allow participant to publish data

• bool hidden = 7

  indicates that it's hidden to others

• bool recorder = 8

  indicates it's a recorder instance

Used in: UpdateSubscription, UpdateSubscriptionsRequest

• string participant_sid = 1

  participant ID of participant to whom the tracks belong

• repeated string track_sids = 2

Used in: SignalResponse

• repeated ParticipantInfo participants = 1

message to RTC nodes

• string participant_key = 1

• int64 sender_time = 11

• string connection_id = 13

• oneof message

  • StartSession start_session = 2

  • SignalRequest request = 3

  • RoomParticipantIdentity remove_participant = 4

    internal messages

  • MuteRoomTrackRequest mute_track = 5

  • UpdateParticipantRequest update_participant = 6

  • DeleteRoomRequest delete_room = 7

  • UpdateSubscriptionsRequest update_subscriptions = 8

  • SendDataRequest send_data = 9

  • UpdateRoomMetadataRequest update_room_metadata = 10

  • KeepAlive keep_alive = 12

• optional google.protobuf.Timestamp start_time = 1

• optional google.protobuf.Timestamp end_time = 2

• double duration = 3

• uint32 packets = 4

• double packet_rate = 5

• uint64 bytes = 6

• uint64 header_bytes = 39

• double bitrate = 7

• uint32 packets_lost = 8

• double packet_loss_rate = 9

• float packet_loss_percentage = 10

• uint32 packets_duplicate = 11

• double packet_duplicate_rate = 12

• uint64 bytes_duplicate = 13

• uint64 header_bytes_duplicate = 40

• double bitrate_duplicate = 14

• uint32 packets_padding = 15

• double packet_padding_rate = 16

• uint64 bytes_padding = 17

• uint64 header_bytes_padding = 41

• double bitrate_padding = 18

• uint32 packets_out_of_order = 19

• uint32 frames = 20

• double frame_rate = 21

• double jitter_current = 22

• double jitter_max = 23

• map<int32, uint32> gap_histogram = 24

• uint32 nacks = 25

• uint32 nack_acks = 37

• uint32 nack_misses = 26

• uint32 nack_repeated = 38

• uint32 plis = 27

• optional google.protobuf.Timestamp last_pli = 28

• uint32 firs = 29

• optional google.protobuf.Timestamp last_fir = 30

• uint32 rtt_current = 31

• uint32 rtt_max = 32

• uint32 key_frames = 33

• optional google.protobuf.Timestamp last_key_frame = 34

• uint32 layer_lock_plis = 35

• optional google.protobuf.Timestamp last_layer_lock_pli = 36

• string participant_id = 1

Used as response type in: RoomService.CreateRoom, RoomService.UpdateRoomMetadata

Used as field type in: AnalyticsEvent, JoinResponse, ListRoomsResponse, RoomUpdate, WebhookEvent

• string sid = 1

• string name = 2

• uint32 empty_timeout = 3

• uint32 max_participants = 4

• int64 creation_time = 5

• string turn_password = 6

• repeated Codec enabled_codecs = 7

• string metadata = 8

• uint32 num_participants = 9

• bool active_recording = 10

composite using a web browser

Used as request type in: Egress.StartRoomCompositeEgress

Used as field type in: EgressInfo, RoomEgress, StartEgressRequest

• string room_name = 1

  required

• string layout = 2

  (optional)

• bool audio_only = 3

  (default false)

• bool video_only = 4

  (default false)

• string custom_base_url = 5

  (default https://recorder.livekit.io)

• oneof output

  required

  • EncodedFileOutput file = 6

  • StreamOutput stream = 7

  • SegmentedFileOutput segments = 10

• oneof options

  • EncodingOptionsPreset preset = 8

    (default H264_720P_30)

  • EncodingOptions advanced = 9

    (optional)

Used in: CreateRoomRequest

• optional RoomCompositeEgressRequest room = 1

• optional AutoTrackEgress tracks = 2

room info that should not be returned to clients

• optional AutoTrackEgress track_egress = 1

Used as request type in: RoomService.GetParticipant, RoomService.RemoveParticipant

Used as field type in: RTCNodeMessage

• string room = 1

  name of the room

• string identity = 2

  identity of the participant

Used in: SignalResponse

• optional Room room = 1

Used in: AutoTrackEgress, DirectFileOutput, EncodedFileOutput, SegmentedFileOutput

• string access_key = 1

• string secret = 2

• string region = 3

• string endpoint = 4

• string bucket = 5

Used to generate HLS segments or other kind of segmented output

Used in: RoomCompositeEgressRequest, TrackCompositeEgressRequest

• SegmentedFileProtocol protocol = 1

  (optional)

• string filename_prefix = 2

  (optional)

• string playlist_name = 3

  (optional)

• uint32 segment_duration = 4

  (optional)

• oneof output

  required

  • S3Upload s3 = 5

  • GCPUpload gcp = 6

  • AzureBlobUpload azure = 7

Used in: SegmentedFileOutput

• DEFAULT_SEGMENTED_FILE_PROTOCOL = 0

• HLS_PROTOCOL = 1

Used in: EgressInfo

• string playlist_name = 1

• int64 duration = 2

• int64 size = 3

• string playlist_location = 4

• int64 segment_count = 5

Used as request type in: RoomService.SendData

Used as field type in: RTCNodeMessage

• string room = 1

• bytes data = 2

• DataPacket.Kind kind = 3

• repeated string destination_sids = 4

details about the server

Used in: JoinResponse

• ServerInfo.Edition edition = 1

• string version = 2

• int32 protocol = 3

• string region = 4

• string node_id = 5

• string debug_info = 6

  additional debugging information. sent only if server is in development mode

Used in: ServerInfo

• Standard = 0

• Cloud = 1

Used in: SignalRequest, SignalResponse, SyncState

• string type = 1

  "answer" | "offer" | "pranswer" | "rollback"

• string sdp = 2

message to Signal nodes

• string connection_id = 1

• oneof message

  • SignalResponse response = 2

  • EndSession end_session = 3

Used in: RTCNodeMessage

• oneof message

  • SessionDescription offer = 1

    initial join exchange, for publisher

  • SessionDescription answer = 2

    participant answering publisher offer

  • TrickleRequest trickle = 3

  • AddTrackRequest add_track = 4

  • MuteTrackRequest mute = 5

    mute the participant's published tracks

  • UpdateSubscription subscription = 6

    Subscribe or unsubscribe from tracks

  • UpdateTrackSettings track_setting = 7

    Update settings of subscribed tracks

  • LeaveRequest leave = 8

    Immediately terminate session

  • UpdateVideoLayers update_layers = 10

    Set active published layers, deprecated in favor of automatic tracking SetSimulcastLayers simulcast = 9; Update published video layers

  • SubscriptionPermission subscription_permission = 11

    Update subscriber permissions

  • SyncState sync_state = 12

    sync client's subscribe state to server during reconnect

  • SimulateScenario simulate = 13

    Simulate conditions, for client validations

  • int64 ping = 14

    client triggered ping to server

Used in: SignalNodeMessage

• oneof message

  • JoinResponse join = 1

    sent when join is accepted

  • SessionDescription answer = 2

    sent when server answers publisher

  • SessionDescription offer = 3

    sent when server is sending subscriber an offer

  • TrickleRequest trickle = 4

    sent when an ICE candidate is available

  • ParticipantUpdate update = 5

    sent when participants in the room has changed

  • TrackPublishedResponse track_published = 6

    sent to the participant when their track has been published

  • LeaveRequest leave = 8

    Immediately terminate session

  • MuteTrackRequest mute = 9

    server initiated mute

  • SpeakersChanged speakers_changed = 10

    indicates changes to speaker status, including when they've gone to not speaking

  • RoomUpdate room_update = 11

    sent when metadata of the room has changed

  • ConnectionQualityUpdate connection_quality = 12

    when connection quality changed

  • StreamStateUpdate stream_state_update = 13

    when streamed tracks state changed, used to notify when any of the streams were paused due to congestion

  • SubscribedQualityUpdate subscribed_quality_update = 14

    when max subscribe quality changed, used by dynamic broadcasting to disable unused layers

  • SubscriptionPermissionUpdate subscription_permission_update = 15

    when subscription permission changed

  • string refresh_token = 16

    update the token the client was using, to prevent an active client from using an expired token

  • TrackUnpublishedResponse track_unpublished = 17

    server initiated track unpublish

  • int64 pong = 18

    respond to ping

Used in: DataChannelInfo, TrickleRequest

• PUBLISHER = 0

• SUBSCRIBER = 1

Used in: SignalRequest

• oneof scenario

  • int32 speaker_update = 1

    simulate N seconds of speaker activity

  • bool node_failure = 2

    simulate local node failure

  • bool migration = 3

    simulate migration

  • bool server_leave = 4

    server to send leave

  • CandidateProtocol switch_candidate_protocol = 5

    switch candidate protocol to tcp

Used in: AddTrackRequest

• string codec = 1

• string cid = 2

• bool enable_simulcast_layers = 3

Used in: TrackInfo

• string mime_type = 1

• string mid = 2

• string cid = 3

• repeated VideoLayer layers = 4

Used in: ActiveSpeakerUpdate, SpeakersChanged

• string sid = 1

• float level = 2

  audio level, 0-1.0, 1 is loudest

• bool active = 3

  true if speaker is currently active

Used in: SignalResponse

• repeated SpeakerInfo speakers = 1

• string egress_id = 1

  request metadata

• string request_id = 2

• string sender_id = 10

• int64 sent_at = 4

• oneof request

  request

  • RoomCompositeEgressRequest room_composite = 5

  • TrackCompositeEgressRequest track_composite = 6

  • TrackEgressRequest track = 7

• string room_id = 3

  connection info

• string token = 8

• string ws_url = 9

Used in: RTCNodeMessage

• string room_name = 1

• string identity = 2

• string connection_id = 3

• bool reconnect = 4

  if a client is reconnecting (i.e. resume instead of restart)

• bool auto_subscribe = 9

• bool hidden = 10

• optional ClientInfo client = 11

• bool recorder = 12

• string name = 13

• string grants_json = 14

  A user's ClaimGrants serialized in JSON

• bool adaptive_stream = 15

• string participant_id = 16

  if reconnect, client will set current sid

Used as request type in: Egress.StopEgress

Used as field type in: EgressRequest

• string egress_id = 1

Used in: StreamInfoList

• string url = 1

• int64 started_at = 2

• int64 ended_at = 3

• int64 duration = 4

• StreamInfo.Status status = 5

Used in: StreamInfo

• ACTIVE = 0

• FINISHED = 1

• FAILED = 2

Used in: EgressInfo

• repeated StreamInfo info = 1

Used in: RoomCompositeEgressRequest, TrackCompositeEgressRequest

• StreamProtocol protocol = 1

  required

• repeated string urls = 2

  required

Used in: StreamOutput

• DEFAULT_PROTOCOL = 0

  protocol chosen based on urls

• RTMP = 1

Used in: StreamStateInfo

• ACTIVE = 0

• PAUSED = 1

Used in: StreamStateUpdate

• string participant_sid = 1

• string track_sid = 2

• StreamState state = 3

Used in: SignalResponse

• repeated StreamStateInfo stream_states = 1

Used in: AnalyticsStat

• UPSTREAM = 0

• DOWNSTREAM = 1

Used in: SubscribedQualityUpdate

• string codec = 1

• repeated SubscribedQuality qualities = 2

Used in: SubscribedCodec, SubscribedQualityUpdate

• VideoQuality quality = 1

• bool enabled = 2

Used in: SignalResponse

• string track_sid = 1

• repeated SubscribedQuality subscribed_qualities = 2

• repeated SubscribedCodec subscribed_codecs = 3

Used in: SignalRequest

• bool all_participants = 1

• repeated TrackPermission track_permissions = 2

Used in: SignalResponse

• string participant_sid = 1

• string track_sid = 2

• bool allowed = 3

Used in: SignalRequest

• optional SessionDescription answer = 1

  last subscribe answer before reconnecting

• optional UpdateSubscription subscription = 2

• repeated TrackPublishedResponse publish_tracks = 3

• repeated DataChannelInfo data_channels = 4

• optional SessionDescription offer = 5

  last received server side offer before reconnecting

• int64 unix_micro = 1

• int32 ticks = 2

containerize up to one audio and one video track

Used as request type in: Egress.StartTrackCompositeEgress

Used as field type in: EgressInfo, StartEgressRequest

• string room_name = 1

  required

• string audio_track_id = 2

  (optional)

• string video_track_id = 3

  (optional)

• oneof output

  required

  • EncodedFileOutput file = 4

  • StreamOutput stream = 5

  • SegmentedFileOutput segments = 8

• oneof options

  • EncodingOptionsPreset preset = 6

    (default H264_720P_30)

  • EncodingOptions advanced = 7

    (optional)

record tracks individually, without transcoding

Used as request type in: Egress.StartTrackEgress

Used as field type in: EgressInfo, StartEgressRequest

• string room_name = 1

  required

• string track_id = 2

  required

• oneof output

  required

  • DirectFileOutput file = 3

  • string websocket_url = 4

Used in: AnalyticsEvent, IngressState, MuteRoomTrackResponse, ParticipantInfo, TrackPublishedResponse, WebhookEvent

• string sid = 1

• TrackType type = 2

• string name = 3

• bool muted = 4

• uint32 width = 5

  original width of video (unset for audio) clients may receive a lower resolution version with simulcast

• uint32 height = 6

  original height of video (unset for audio)

• bool simulcast = 7

  true if track is simulcasted

• bool disable_dtx = 8

  true if DTX (Discontinuous Transmission) is disabled for audio

• TrackSource source = 9

  source of media

• repeated VideoLayer layers = 10

• string mime_type = 11

  mime type of codec

• string mid = 12

• repeated SimulcastCodecInfo codecs = 13

Used in: SubscriptionPermission

• string participant_sid = 1

  permission could be granted either by participant sid or identity

• bool all_tracks = 2

• repeated string track_sids = 3

• string participant_identity = 4

Used in: SignalResponse, SyncState

• string cid = 1

• optional TrackInfo track = 2

Used in: AddTrackRequest, IngressAudioOptions, IngressVideoOptions, TrackInfo

• UNKNOWN = 0

• CAMERA = 1

• MICROPHONE = 2

• SCREEN_SHARE = 3

• SCREEN_SHARE_AUDIO = 4

Used in: AddTrackRequest, TrackInfo

• AUDIO = 0

• VIDEO = 1

• DATA = 2

Used in: SignalResponse

• string track_sid = 1

Used in: SignalRequest, SignalResponse

• string candidateInit = 1

• SignalTarget target = 2

Used as request type in: Ingress.UpdateIngress

Used as field type in: IngressRequest

• string ingress_id = 1

• string name = 2

• string room_name = 3

• string participant_identity = 4

• string participant_name = 5

• optional IngressAudioOptions audio = 6

• optional IngressVideoOptions video = 7

Used as request type in: RoomService.UpdateParticipant

Used as field type in: RTCNodeMessage

• string room = 1

• string identity = 2

• string metadata = 3

  metadata to update. skipping updates if left empty

• optional ParticipantPermission permission = 4

  set to update the participant's permissions

Used as request type in: RoomService.UpdateRoomMetadata

Used as field type in: RTCNodeMessage

• string room = 1

• string metadata = 2

  metadata to update. skipping updates if left empty

Used as request type in: Egress.UpdateStream

Used as field type in: EgressRequest

• string egress_id = 1

• repeated string add_output_urls = 2

• repeated string remove_output_urls = 3

Used in: SignalRequest, SyncState

• repeated string track_sids = 1

• bool subscribe = 2

• repeated ParticipantTracks participant_tracks = 3

Used as request type in: RoomService.UpdateSubscriptions

Used as field type in: RTCNodeMessage

• string room = 1

• string identity = 2

• repeated string track_sids = 3

  list of sids of tracks

• bool subscribe = 4

  set to true to subscribe, false to unsubscribe from tracks

• repeated ParticipantTracks participant_tracks = 5

  list of participants and their tracks

Used in: SignalRequest

• repeated string track_sids = 1

• bool disabled = 3

  when true, the track is placed in a paused state, with no new data returned

• VideoQuality quality = 4

  deprecated in favor of width & height

• uint32 width = 5

  for video, width to receive

• uint32 height = 6

  for video, height to receive

message to indicate published video track dimensions are changing

Used in: SignalRequest

• string track_sid = 1

• repeated VideoLayer layers = 2

Used in: DataPacket

• string participant_sid = 1

  participant ID of user that sent the message

• bytes payload = 2

  user defined payload

• repeated string destination_sids = 3

  the ID of the participants who will receive the message (the message will be sent to all the people in the room if this variable is empty)

Used in: EncodingOptions

• DEFAULT_VC = 0

• H264_BASELINE = 1

• H264_MAIN = 2

• H264_HIGH = 3

Used in: ClientConfiguration

• ClientConfigSetting hardware_encoder = 1

provide information about available spatial layers

Used in: AddTrackRequest, IngressVideoOptions, SimulcastCodecInfo, TrackInfo, UpdateVideoLayers

• VideoQuality quality = 1

  for tracks with a single layer, this should be HIGH

• uint32 width = 2

• uint32 height = 3

• uint32 bitrate = 4

  target bitrate, server will measure actual

• uint32 ssrc = 5

Used in: AnalyticsEvent, SubscribedQuality, UpdateTrackSettings, VideoLayer

• LOW = 0

• MEDIUM = 1

• HIGH = 2

• OFF = 3

• string event = 1

  one of room_started, room_finished, participant_joined, participant_left, track_published, track_unpublished, egress_started, egress_updated, egress_ended, ingress_started, ingress_ended

• optional Room room = 2

• optional ParticipantInfo participant = 3

  set when event is participant_* or track_*

• optional EgressInfo egress_info = 9

  set when event is egress_*

• optional IngressInfo ingress_info = 10

  set when event is ingress_*

• optional TrackInfo track = 8

  set when event is track_*

• string id = 6

  unique event uuid

• int64 created_at = 7

  timestamp in seconds