package livekit

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: DataPacket

• repeated SpeakerInfo speakers = 1

Used in: DirectFileOutput, EncodedFileOutput, ImageOutput, SegmentedFileOutput

• string access_key = 1

• string secret = 2

• string region = 3

• string endpoint = 4

• string bucket = 5

Used in: EncodingOptions, IngressAudioEncodingOptions

• DEFAULT_AC = 0

• OPUS = 1

• AAC = 2

• TF_STEREO = 0

• TF_NO_DTX = 1

• TF_AUTO_GAIN_CONTROL = 2

• TF_ECHO_CANCELLATION = 3

• TF_NOISE_SUPPRESSION = 4

• TF_ENHANCED_NOISE_CANCELLATION = 5

Used in: RoomEgress

• oneof options

  • EncodingOptionsPreset preset = 1

    (default H264_720P_30)

  • EncodingOptions advanced = 2

    (optional)

• repeated EncodedFileOutput file_outputs = 3

• repeated SegmentedFileOutput segment_outputs = 4

Used in: RoomEgress

• string filepath = 1

  see docs for templating (default {track_id}-{time})

• bool disable_manifest = 5

  disables upload of json manifest file (default false)

• oneof output

  • S3Upload s3 = 2

  • GCPUpload gcp = 3

  • AzureBlobUpload azure = 4

Used in: AutoTrackEgress, DirectFileOutput, EncodedFileOutput, ImageOutput, SegmentedFileOutput

• string account_name = 1

• string account_key = 2

• string container_name = 3

Used in: ClientConfiguration, VideoConfiguration

• UNSET = 0

• DISABLED = 1

• ENABLED = 2

server provided client configuration

• 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

• 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

• REACT_NATIVE = 7

• RUST = 8

• PYTHON = 9

• CPP = 10

Used in: DisabledCodecs, Room

• string mime = 1

• string fmtp_line = 2

• POOR = 0

• GOOD = 1

• EXCELLENT = 2

• LOST = 3

• IngressInput input_type = 1

• string url = 9

  Where to pull media from, only for URL input type

• 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)

• string participant_metadata = 10

  metadata associated with the publishing participant

• bool bypass_transcoding = 8

  [depreacted ] whether to pass through the incoming media without transcoding, only compatible with some input types. Use `enable_transcoding` instead.

• optional bool enable_transcoding = 11

  Whether to transcode the ingested media. Only WHIP supports disabling transcoding currently. WHIP will default to transcoding disabled. Replaces `bypass_transcoding.

• optional IngressAudioOptions audio = 6

• optional IngressVideoOptions video = 7

• string name = 1

  name of the room

• uint32 empty_timeout = 2

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

• uint32 departure_timeout = 10

  number of seconds to keep the room open after everyone leaves

• 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

• uint32 min_playout_delay = 7

  playout delay of subscriber

• uint32 max_playout_delay = 8

• bool sync_streams = 9

  improves A/V sync when playout_delay set to a value larger than 200ms. It will disables transceiver re-use so not recommended for rooms with frequent subscription changes

new DataPacket API

• DataPacket.Kind kind = 1

• string participant_identity = 4

  participant identity of user that sent the message

• repeated string destination_identities = 5

  identities of participants who will receive the message (sent to all by default)

• oneof value

  • UserPacket user = 2

  • ActiveSpeakerUpdate speaker = 3

  • SipDTMF sip_dtmf = 6

Used in: DataPacket, SendDataRequest

• RELIABLE = 0

• LOSSY = 1

• string ingress_id = 1

• string room = 1

  name of the room

(message has no fields)

Used in: TrackEgressRequest

• string filepath = 1

  see egress docs for templating (default {track_id}-{time})

• bool disable_manifest = 5

  disable upload of manifest file (default false)

• oneof output

  • S3Upload s3 = 2

  • GCPUpload gcp = 3

  • AzureBlobUpload azure = 4

  • AliOSSUpload aliOSS = 6

Used in: ClientConfiguration

• repeated Codec codecs = 1

  disabled for both publish and subscribe

• repeated Codec publish = 2

  only disable for publish

• UNKNOWN_REASON = 0

• CLIENT_INITIATED = 1

• DUPLICATE_IDENTITY = 2

• SERVER_SHUTDOWN = 3

• PARTICIPANT_REMOVED = 4

• ROOM_DELETED = 5

• STATE_MISMATCH = 6

• JOIN_FAILURE = 7

• MIGRATION = 8

• SIGNAL_CLOSE = 9

Used in: 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

• int64 updated_at = 18

• string details = 21

• string error = 9

• oneof request

  • RoomCompositeEgressRequest room_composite = 4

  • WebEgressRequest web = 14

  • ParticipantEgressRequest participant = 19

  • TrackCompositeEgressRequest track_composite = 5

  • TrackEgressRequest track = 6

• oneof result

  deprecated (use _result fields)

  • StreamInfoList stream = 7

  • FileInfo file = 8

  • SegmentsInfo segments = 12

• repeated StreamInfo stream_results = 15

• repeated FileInfo file_results = 16

• repeated SegmentsInfo segment_results = 17

• repeated ImagesInfo image_results = 20

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: AutoParticipantEgress, ParticipantEgressRequest, RoomCompositeEgressRequest, TrackCompositeEgressRequest, WebEgressRequest

• EncodedFileType file_type = 1

  (optional)

• string filepath = 2

  see egress docs for templating (default {room_name}-{time})

• bool disable_manifest = 6

  disable upload of manifest file (default false)

• oneof output

  • S3Upload s3 = 3

  • GCPUpload gcp = 4

  • AzureBlobUpload azure = 5

  • AliOSSUpload aliOSS = 7

Used in: EncodedFileOutput

• DEFAULT_FILETYPE = 0

  file type chosen based on codecs

• MP4 = 1

• OGG = 2

Used in: AutoParticipantEgress, ParticipantEgressRequest, RoomCompositeEgressRequest, TrackCompositeEgressRequest, WebEgressRequest

• 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_quality = 11

  quality setting on audio encoder

• int32 audio_frequency = 7

  (default 44100)

• VideoCodec video_codec = 8

  (default H264_MAIN)

• int32 video_bitrate = 9

  (default 4500)

• int32 video_quality = 12

  quality setting on video encoder

• double key_frame_interval = 10

  in seconds (default 4s for streaming, segment duration for segmented output, encoder default for files)

Used in: AutoParticipantEgress, ParticipantEgressRequest, RoomCompositeEgressRequest, TrackCompositeEgressRequest, WebEgressRequest

• 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

(message has no fields)

Used in: TrackInfo

• NONE = 0

• GCM = 1

• CUSTOM = 2

Used in: EgressInfo

• string filename = 1

• int64 started_at = 2

• int64 ended_at = 3

• int64 duration = 6

• int64 size = 4

• string location = 5

Used in: AutoTrackEgress, DirectFileOutput, EncodedFileOutput, ImageOutput, SegmentedFileOutput

• string credentials = 1

  service account credentials serialized in JSON "credentials.json"

• string bucket = 2

• optional ProxyConfig proxy = 3

Used in: ImageOutput

• IC_DEFAULT = 0

• IC_JPEG = 1

Used in: ImageOutput

• IMAGE_SUFFIX_INDEX = 0

• IMAGE_SUFFIX_TIMESTAMP = 1

Used in: ParticipantEgressRequest, RoomCompositeEgressRequest, TrackCompositeEgressRequest, WebEgressRequest

• uint32 capture_interval = 1

  in seconds (required)

• int32 width = 2

  (optional, defaults to track width)

• int32 height = 3

  (optional, defaults to track height)

• string filename_prefix = 4

  (optional)

• ImageFileSuffix filename_suffix = 5

  (optional, default INDEX)

• ImageCodec image_codec = 6

  (optional)

• bool disable_manifest = 7

  disable upload of manifest file (default false)

• oneof output

  required

  • S3Upload s3 = 8

  • GCPUpload gcp = 9

  • AzureBlobUpload azure = 10

  • AliOSSUpload aliOSS = 11

Used in: EgressInfo

• int64 image_count = 1

• int64 started_at = 2

• int64 ended_at = 3

Used in: IngressAudioOptions

• AudioCodec audio_codec = 1

  desired audio codec to publish to room

• uint32 bitrate = 2

• bool disable_dtx = 3

• uint32 channels = 4

Used in: IngressAudioOptions

• OPUS_STEREO_96KBPS = 0

  OPUS, 2 channels, 96kbps

• OPUS_MONO_64KBS = 1

  OPUS, 1 channel, 64kbps

Used in: CreateIngressRequest, IngressInfo, UpdateIngressRequest

• string name = 1

• TrackSource source = 2

• oneof encoding_options

  • IngressAudioEncodingPreset preset = 3

  • IngressAudioEncodingOptions options = 4

Used in: ListIngressResponse, WebhookEvent

• string ingress_id = 1

• string name = 2

• string stream_key = 3

• string url = 4

  URL to point the encoder to for push (RTMP, WHIP), or location to pull media from for pull (URL)

• 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

• bool bypass_transcoding = 13

• optional bool enable_transcoding = 15

• optional IngressAudioOptions audio = 6

• optional IngressVideoOptions video = 7

• string room_name = 8

• string participant_identity = 9

• string participant_name = 10

• string participant_metadata = 14

• 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

• WHIP_INPUT = 1

• URL_INPUT = 2

  Pull from the provided URL. Only HTTP url are supported, serving either a single media file or a HLS stream

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

• int64 ended_at = 8

• int64 updated_at = 10

• string resource_id = 9

• repeated TrackInfo tracks = 6

Used in: IngressState

• ENDPOINT_INACTIVE = 0

• ENDPOINT_BUFFERING = 1

• ENDPOINT_PUBLISHING = 2

• ENDPOINT_ERROR = 3

• ENDPOINT_COMPLETE = 4

Used in: IngressVideoOptions

• VideoCodec video_codec = 1

  desired codec to publish to room

• double frame_rate = 2

• repeated VideoLayer layers = 3

  simulcast layers to publish, when empty, should usually be set to layers at 1/2 and 1/4 of the dimensions

Used in: IngressVideoOptions

• H264_720P_30FPS_3_LAYERS = 0

  1280x720, 30fps, 1900kbps main layer, 3 layers total

• H264_1080P_30FPS_3_LAYERS = 1

  1980x1080, 30fps, 3500kbps main layer, 3 layers total

• H264_540P_25FPS_2_LAYERS = 2

  960x540, 25fps, 1000kbps main layer, 2 layers total

• H264_720P_30FPS_1_LAYER = 3

  1280x720, 30fps, 1900kbps, no simulcast

• H264_1080P_30FPS_1_LAYER = 4

  1980x1080, 30fps, 3500kbps, no simulcast

• H264_720P_30FPS_3_LAYERS_HIGH_MOTION = 5

  1280x720, 30fps, 2500kbps main layer, 3 layers total, higher bitrate for high motion, harder to encode content

• H264_1080P_30FPS_3_LAYERS_HIGH_MOTION = 6

  1980x1080, 30fps, 4500kbps main layer, 3 layers total, higher bitrate for high motion, harder to encode content

• H264_540P_25FPS_2_LAYERS_HIGH_MOTION = 7

  960x540, 25fps, 1300kbps main layer, 2 layers total, higher bitrate for high motion, harder to encode content

• H264_720P_30FPS_1_LAYER_HIGH_MOTION = 8

  1280x720, 30fps, 2500kbps, no simulcast, higher bitrate for high motion, harder to encode content

• H264_1080P_30FPS_1_LAYER_HIGH_MOTION = 9

  1980x1080, 30fps, 4500kbps, no simulcast, higher bitrate for high motion, harder to encode content

Used in: CreateIngressRequest, IngressInfo, UpdateIngressRequest

• string name = 1

• TrackSource source = 2

• oneof encoding_options

  • IngressVideoEncodingPreset preset = 3

  • IngressVideoEncodingOptions options = 4

Used in: IngressState

• string mime_type = 1

• uint32 average_bitrate = 2

• uint32 channels = 3

• uint32 sample_rate = 4

Used in: IngressState

• string mime_type = 1

• uint32 average_bitrate = 2

• uint32 width = 3

• uint32 height = 4

• double framerate = 5

• string room_name = 1

  (optional, filter by room name)

• string egress_id = 2

  (optional, filter by egress ID)

• bool active = 3

  (optional, list active egress only)

• repeated EgressInfo items = 1

• string room_name = 1

  when blank, lists all ingress endpoints

  (optional, filter by room name)

• string ingress_id = 2

  (optional, filter by ingress ID)

• repeated IngressInfo items = 1

• string room = 1

  name of the room

• repeated ParticipantInfo participants = 1

• repeated string names = 1

  when set, will only return rooms with name match

• repeated Room rooms = 1

• 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

• optional TrackInfo track = 1

record audio and video from a single participant

Used in: EgressInfo

• string room_name = 1

  required

• string identity = 2

  required

• bool screen_share = 3

  (default false)

• oneof options

  • EncodingOptionsPreset preset = 4

    (default H264_720P_30)

  • EncodingOptions advanced = 5

    (optional)

• repeated EncodedFileOutput file_outputs = 6

• repeated StreamOutput stream_outputs = 7

• repeated SegmentedFileOutput segment_outputs = 8

• repeated ImageOutput image_outputs = 9

Used in: ListParticipantsResponse, 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

• ParticipantInfo.Kind kind = 14

Used in: ParticipantInfo

• STANDARD = 0

  standard participants, e.g. web clients

• INGRESS = 1

  only ingests streams

• EGRESS = 2

  only consumes streams

• SIP = 3

  SIP participants

• AGENT = 4

  LiveKit agents

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

• repeated TrackSource can_publish_sources = 9

  sources that are allowed to be published

• bool hidden = 7

  indicates that it's hidden to others

• bool recorder = 8

  indicates it's a recorder instance

• bool can_update_metadata = 10

  indicates that participant can update own metadata

• bool agent = 11

  indicates that participant is an agent

Used in: UpdateSubscriptionsRequest

• string participant_sid = 1

  participant ID of participant to whom the tracks belong

• repeated string track_sids = 2

• bool enabled = 1

• uint32 min = 2

• uint32 max = 3

Used in: GCPUpload, S3Upload

• string url = 1

• string username = 2

• string password = 3

Used in: RTPStats

• optional google.protobuf.Timestamp start_time = 1

• optional google.protobuf.Timestamp end_time = 2

• double duration = 3

• uint64 start_timestamp = 4

• uint64 end_timestamp = 5

• uint64 rtp_clock_ticks = 6

• int64 drift_samples = 7

• double drift_ms = 8

• double clock_rate = 9

• 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

• optional RTPDrift packet_drift = 44

• optional RTPDrift report_drift = 45

• optional RTPDrift rebased_report_drift = 46

  NEXT_ID: 47

• RR_UNKNOWN = 0

• RR_SIGNAL_DISCONNECTED = 1

• RR_PUBLISHER_FAILED = 2

• RR_SUBSCRIBER_FAILED = 3

• RR_SWITCH_CANDIDATE = 4

(message has no fields)

Used in: ListRoomsResponse, WebhookEvent

• string sid = 1

• string name = 2

• uint32 empty_timeout = 3

• uint32 departure_timeout = 14

• uint32 max_participants = 4

• int64 creation_time = 5

• string turn_password = 6

• repeated Codec enabled_codecs = 7

• string metadata = 8

• uint32 num_participants = 9

• uint32 num_publishers = 11

• bool active_recording = 10

• optional TimedVersion version = 13

composite using a web browser

Used in: EgressInfo, RoomEgress

• 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

  template base url (default https://recorder.livekit.io)

• oneof output

  deprecated (use _output fields)

  • EncodedFileOutput file = 6

  • StreamOutput stream = 7

  • SegmentedFileOutput segments = 10

• oneof options

  • EncodingOptionsPreset preset = 8

    (default H264_720P_30)

  • EncodingOptions advanced = 9

    (optional)

• repeated EncodedFileOutput file_outputs = 11

• repeated StreamOutput stream_outputs = 12

• repeated SegmentedFileOutput segment_outputs = 13

• repeated ImageOutput image_outputs = 14

Used in: CreateRoomRequest

• optional RoomCompositeEgressRequest room = 1

• optional AutoParticipantEgress participant = 3

• optional AutoTrackEgress tracks = 2

• string room = 1

  name of the room

• string identity = 2

  identity of the participant

Used in: AutoTrackEgress, DirectFileOutput, EncodedFileOutput, ImageOutput, SegmentedFileOutput

• string access_key = 1

• string secret = 2

• string region = 3

• string endpoint = 4

• string bucket = 5

• bool force_path_style = 6

• map<string, string> metadata = 7

• string tagging = 8

• string content_disposition = 9

  Content-Disposition header

• optional ProxyConfig proxy = 10

Used to generate HLS segments or other kind of segmented output

Used in: AutoParticipantEgress, ParticipantEgressRequest, RoomCompositeEgressRequest, TrackCompositeEgressRequest, WebEgressRequest

• SegmentedFileProtocol protocol = 1

  (optional)

• string filename_prefix = 2

  (optional)

• string playlist_name = 3

  (optional)

• string live_playlist_name = 11

  (optional, disabled if not provided). Path of a live playlist

• uint32 segment_duration = 4

  in seconds (optional)

• SegmentedFileSuffix filename_suffix = 10

  (optional, default INDEX)

• bool disable_manifest = 8

  disable upload of manifest file (default false)

• oneof output

  required

  • S3Upload s3 = 5

  • GCPUpload gcp = 6

  • AzureBlobUpload azure = 7

  • AliOSSUpload aliOSS = 9

Used in: SegmentedFileOutput

• DEFAULT_SEGMENTED_FILE_PROTOCOL = 0

• HLS_PROTOCOL = 1

Used in: SegmentedFileOutput

• INDEX = 0

• TIMESTAMP = 1

Used in: EgressInfo

• string playlist_name = 1

• string live_playlist_name = 8

• int64 duration = 2

• int64 size = 3

• string playlist_location = 4

• string live_playlist_location = 9

• int64 segment_count = 5

• int64 started_at = 6

• int64 ended_at = 7

• string room = 1

• bytes data = 2

• DataPacket.Kind kind = 3

• repeated string destination_sids = 4

  mark deprecated

• repeated string destination_identities = 6

  when set, only forward to these identities

• optional string topic = 5

(message has no fields)

details about the server

• 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: TrackInfo

• string mime_type = 1

• string mid = 2

• string cid = 3

• repeated VideoLayer layers = 4

Used in: DataPacket

• uint32 code = 3

• string digit = 4

Used in: ActiveSpeakerUpdate

• string sid = 1

• float level = 2

  audio level, 0-1.0, 1 is loudest

• bool active = 3

  true if speaker is currently active

• string egress_id = 1

Used in: EgressInfo, StreamInfoList

• string url = 1

• int64 started_at = 2

• int64 ended_at = 3

• int64 duration = 4

• StreamInfo.Status status = 5

• string error = 6

Used in: StreamInfo

• ACTIVE = 0

• FINISHED = 1

• FAILED = 2

Used in: EgressInfo

• repeated StreamInfo info = 1

Used in: ParticipantEgressRequest, RoomCompositeEgressRequest, TrackCompositeEgressRequest, WebEgressRequest

• StreamProtocol protocol = 1

  required

• repeated string urls = 2

  required

Used in: StreamOutput

• DEFAULT_PROTOCOL = 0

  protocol chosen based on urls

• RTMP = 1

• SE_UNKNOWN = 0

• SE_CODEC_UNSUPPORTED = 1

• SE_TRACK_NOTFOUND = 2

Used in: Room, TrackInfo

• int64 unix_micro = 1

• int32 ticks = 2

containerize up to one audio and one video track

Used in: EgressInfo

• string room_name = 1

  required

• string audio_track_id = 2

  (optional)

• string video_track_id = 3

  (optional)

• oneof output

  deprecated (use _output fields)

  • EncodedFileOutput file = 4

  • StreamOutput stream = 5

  • SegmentedFileOutput segments = 8

• oneof options

  • EncodingOptionsPreset preset = 6

    (default H264_720P_30)

  • EncodingOptions advanced = 7

    (optional)

• repeated EncodedFileOutput file_outputs = 11

• repeated StreamOutput stream_outputs = 12

• repeated SegmentedFileOutput segment_outputs = 13

• repeated ImageOutput image_outputs = 14

record tracks individually, without transcoding

Used in: EgressInfo

• string room_name = 1

  required

• string track_id = 2

  required

• oneof output

  required

  • DirectFileOutput file = 3

  • string websocket_url = 4

Used in: IngressState, MuteRoomTrackResponse, ParticipantInfo, 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

• bool stereo = 14

• bool disable_red = 15

  true if RED (Redundant Encoding) is disabled for audio

• Encryption.Type encryption = 16

• string stream = 17

• optional TimedVersion version = 18

Used in: IngressAudioOptions, IngressVideoOptions, ParticipantPermission, TrackInfo

• UNKNOWN = 0

• CAMERA = 1

• MICROPHONE = 2

• SCREEN_SHARE = 3

• SCREEN_SHARE_AUDIO = 4

Used in: TrackInfo

• AUDIO = 0

• VIDEO = 1

• DATA = 2

• string ingress_id = 1

• string name = 2

• string room_name = 3

• string participant_identity = 4

• string participant_name = 5

• string participant_metadata = 9

• optional bool bypass_transcoding = 8

• optional bool enable_transcoding = 10

• optional IngressAudioOptions audio = 6

• optional IngressVideoOptions video = 7

• string egress_id = 1

• string layout = 2

• 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

• string name = 5

  display name to update

• string room = 1

• string metadata = 2

  metadata to update. skipping updates if left empty

• string egress_id = 1

• repeated string add_output_urls = 2

• repeated string remove_output_urls = 3

• 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

empty for now

(message has no fields)

Used in: DataPacket

• string participant_sid = 1

  participant ID of user that sent the message

• string participant_identity = 5

• bytes payload = 2

  user defined payload

• repeated string destination_sids = 3

  the ID of the participants who will receive the message (sent to all by default)

• repeated string destination_identities = 6

  identities of participants who will receive the message (sent to all by default)

• optional string topic = 4

  topic under which the message was published

Used in: EncodingOptions, IngressVideoEncodingOptions

• DEFAULT_VC = 0

• H264_BASELINE = 1

• H264_MAIN = 2

• H264_HIGH = 3

• VP8 = 4

Used in: ClientConfiguration

• ClientConfigSetting hardware_encoder = 1

provide information about available spatial layers

Used in: IngressVideoEncodingOptions, SimulcastCodecInfo, TrackInfo

• VideoQuality quality = 1

  for tracks with a single layer, this should be HIGH

• uint32 width = 2

• uint32 height = 3

• uint32 bitrate = 4

  target bitrate in bit per second (bps), server will measure actual

• uint32 ssrc = 5

Used in: VideoLayer

• LOW = 0

• MEDIUM = 1

• HIGH = 2

• OFF = 3

record any website

Used in: EgressInfo

• string url = 1

• bool audio_only = 2

• bool video_only = 3

• bool await_start_signal = 12

• oneof output

  deprecated (use _output fields)

  • EncodedFileOutput file = 4

  • StreamOutput stream = 5

  • SegmentedFileOutput segments = 6

• oneof options

  • EncodingOptionsPreset preset = 7

  • EncodingOptions advanced = 8

• repeated EncodedFileOutput file_outputs = 9

• repeated StreamOutput stream_outputs = 10

• repeated SegmentedFileOutput segment_outputs = 11

• repeated ImageOutput image_outputs = 13

• 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

• int32 num_dropped = 11