package livekit.proto

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: RoomEvent

• repeated string participant_identities = 1

Used in: FfiRequest

• required uint64 apm_handle = 1

• required uint64 data_ptr = 2

  *mut i16

• required uint32 size = 3

  in bytes

• required uint32 sample_rate = 4

• required uint32 num_channels = 5

Used in: FfiResponse

• optional string error = 1

Used in: FfiRequest

• required uint64 apm_handle = 1

• required uint64 data_ptr = 2

  *mut i16

• required uint32 size = 3

  in bytes

• required uint32 sample_rate = 4

• required uint32 num_channels = 5

Used in: FfiResponse

• optional string error = 1

Used in: FfiRequest

• required uint64 apm_handle = 1

• required int32 delay_ms = 2

Used in: FfiResponse

• optional string error = 1

Used in: ParticipantAttributesChanged, SetLocalAttributesRequest

• required string key = 1

• required string value = 2

Used in: TrackPublishOptions

• required uint64 max_bitrate = 1

Used in: CaptureAudioFrameRequest, OwnedAudioFrameBuffer, RemixAndResampleRequest

• required uint64 data_ptr = 1

  *const i16

• required uint32 num_channels = 2

• required uint32 sample_rate = 3

• required uint32 samples_per_channel = 4

Used in: AudioStreamEvent

• required OwnedAudioFrameBuffer frame = 1

Used in: RtcStats.MediaPlayout

• required string kind = 1

• required double synthesized_samples_duration = 2

• required uint32 synthesized_samples_events = 3

• required double total_samples_duration = 4

• required double total_playout_delay = 5

• required uint64 total_samples_count = 6

Used in: OwnedAudioResampler

(message has no fields)

Used in: OwnedAudioSource

• required AudioSourceType type = 2

Used in: NewAudioSourceRequest

• required bool echo_cancellation = 1

• required bool noise_suppression = 2

• required bool auto_gain_control = 3

Used in: RtcStats.MediaSource

• required double audio_level = 1

• required double total_audio_energy = 2

• required double total_samples_duration = 3

• required double echo_return_loss = 4

• required double echo_return_loss_enhancement = 5

• required double dropped_samples_duration = 6

• required uint32 dropped_samples_events = 7

• required double total_capture_delay = 8

• required uint64 total_samples_captured = 9

Used in: AudioSourceInfo, NewAudioSourceRequest

• AUDIO_SOURCE_NATIVE = 0

Used in: AudioStreamEvent

(message has no fields)

Used in: FfiEvent

• required uint64 stream_handle = 1

• oneof message

  • AudioFrameReceived frame_received = 2

  • AudioStreamEOS eos = 3

Used in: FfiRequest

• required uint64 participant_handle = 1

• required AudioStreamType type = 2

• optional TrackSource track_source = 3

• optional uint32 sample_rate = 5

• optional uint32 num_channels = 6

• optional string audio_filter_module_id = 7

• optional string audio_filter_options = 8

Used in: FfiResponse

• required OwnedAudioStream stream = 1

Used in: OwnedAudioStream

• required AudioStreamType type = 1

Used in: AudioStreamFromParticipantRequest, AudioStreamInfo, NewAudioStreamRequest

• AUDIO_STREAM_NATIVE = 0

• AUDIO_STREAM_HTML = 1

Used in: TrackPublicationInfo

• 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

• TF_PRECONNECT_BUFFER = 6

  client will buffer audio once available and send it to the server via bytes stream once connected

Used in: OwnedBuffer

• required uint64 data_ptr = 1

• required uint64 data_len = 2

Used in: OwnedByteStreamReader, OwnedByteStreamWriter, StreamSendFileCallback

• required string stream_id = 1

  unique identifier for this data stream

• required int64 timestamp = 2

  using int64 for Unix timestamp

• required string mime_type = 3

• required string topic = 4

• optional uint64 total_length = 5

  only populated for finite streams, if it's a stream of unknown size this stays empty

• map<string, string> attributes = 6

  user defined attributes map that can carry additional info

• required string name = 7

Used in: FfiEvent

• required uint64 async_id = 1

• oneof result

  • OwnedByteStreamWriter writer = 2

  • StreamError error = 3

Opens an outgoing stream. Call must be balanced with a StreamCloseRequest.

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required StreamByteOptions options = 2

  Options to use for opening the stream.

Used in: FfiResponse

• required uint64 async_id = 1

Used in: RoomEvent

• required OwnedByteStreamReader reader = 1

• required string participant_identity = 2

Used in: ByteStreamReaderEvent

• required bytes content = 1

Used in: ByteStreamReaderEvent

• optional StreamError error = 1

Used in: FfiEvent

• required uint64 reader_handle = 1

• oneof detail

  • ByteStreamReaderChunkReceived chunk_received = 2

  • ByteStreamReaderEOS eos = 3

Used in: FfiEvent

• required uint64 async_id = 1

• oneof result

  • bytes content = 2

  • StreamError error = 3

Reads an incoming byte stream in its entirety.

Used in: FfiRequest

• required uint64 reader_handle = 1

Used in: FfiResponse

• required uint64 async_id = 1

Reads an incoming byte stream incrementally.

Used in: FfiRequest

• required uint64 reader_handle = 1

Used in: FfiResponse

(message has no fields)

Used in: FfiEvent

• required uint64 async_id = 1

• oneof result

  • string file_path = 2

    Path the file was written to.

  • StreamError error = 3

Writes data from an incoming stream to a file as it arrives.

Used in: FfiRequest

• required uint64 reader_handle = 1

• optional string directory = 3

  Directory to write the file in (must be writable by the current process). If not provided, the file will be written to the system's temp directory.

• optional string name_override = 4

  Name to use for the written file. If not provided, the file's name and extension will be inferred from the stream's info.

Used in: FfiResponse

• required uint64 async_id = 1

Used in: FfiEvent

• required uint64 async_id = 1

• optional StreamError error = 2

Closes a stream writer.

Used in: FfiRequest

• required uint64 writer_handle = 1

• optional string reason = 2

Used in: FfiResponse

• required uint64 async_id = 1

Used in: FfiEvent

• required uint64 async_id = 1

• optional StreamError error = 2

Writes data to a stream writer.

Used in: FfiRequest

• required uint64 writer_handle = 1

• required bytes bytes = 2

Used in: FfiResponse

• required uint64 async_id = 1

Used in: RtcStats.CandidatePair

• required string transport_id = 1

• required string local_candidate_id = 2

• required string remote_candidate_id = 3

• optional IceCandidatePairState state = 4

• required bool nominated = 5

• required uint64 packets_sent = 6

• required uint64 packets_received = 7

• required uint64 bytes_sent = 8

• required uint64 bytes_received = 9

• required double last_packet_sent_timestamp = 10

• required double last_packet_received_timestamp = 11

• required double total_round_trip_time = 12

• required double current_round_trip_time = 13

• required double available_outgoing_bitrate = 14

• required double available_incoming_bitrate = 15

• required uint64 requests_received = 16

• required uint64 requests_sent = 17

• required uint64 responses_received = 18

• required uint64 responses_sent = 19

• required uint64 consent_requests_sent = 20

• required uint32 packets_discarded_on_send = 21

• required uint64 bytes_discarded_on_send = 22

Used in: FfiEvent

• required uint64 async_id = 1

• optional string error = 2

Push a frame to an AudioSource The data provided must be available as long as the client receive the callback.

Used in: FfiRequest

• required uint64 source_handle = 1

• required AudioFrameBufferInfo buffer = 2

Used in: FfiResponse

• required uint64 async_id = 1

Push a frame to a VideoSource

Used in: FfiRequest

• required uint64 source_handle = 1

• required VideoBufferInfo buffer = 2

• required int64 timestamp_us = 3

  In microseconds

• required VideoRotation rotation = 4

Used in: FfiResponse

(message has no fields)

Used in: RtcStats.Certificate

• required string fingerprint = 1

• required string fingerprint_algorithm = 2

• required string base64_certificate = 3

• required string issuer_certificate_id = 4

Used in: ChatMessageReceived, EditChatMessageRequest, SendChatMessageCallback

• required string id = 1

• required int64 timestamp = 2

• required string message = 3

• optional int64 edit_timestamp = 4

• optional bool deleted = 5

• optional bool generated = 6

Used in: RoomEvent

• required ChatMessage message = 1

• required string participant_identity = 2

Used in: FfiRequest

• required uint64 source_handle = 1

Used in: FfiResponse

(message has no fields)

Used in: RtcStats.Codec

• required uint32 payload_type = 1

• required string transport_id = 2

• required string mime_type = 3

• required uint32 clock_rate = 4

• required uint32 channels = 5

• required string sdp_fmtp_line = 6

Used in: FfiEvent

• required uint64 async_id = 1

• oneof message

  • string error = 2

  • ConnectCallback.Result result = 3

Used in: Result

• required OwnedParticipant participant = 1

• repeated OwnedTrackPublication publications = 2

  TrackInfo are not needed here, if we're subscribed to a track, the FfiServer will send a TrackSubscribed event

Used in: ConnectCallback

• required OwnedRoom room = 1

• required OwnedParticipant local_participant = 2

• repeated ParticipantWithTracks participants = 3

Connect to a new LiveKit room

Used in: FfiRequest

• required string url = 1

• required string token = 2

• required RoomOptions options = 3

Used in: FfiResponse

• required uint64 async_id = 1

(message has no fields)

Used in: ConnectionQualityChanged

• QUALITY_POOR = 0

• QUALITY_GOOD = 1

• QUALITY_EXCELLENT = 2

• QUALITY_LOST = 3

Used in: RoomEvent

• required string participant_identity = 1

• required ConnectionQuality quality = 2

Used in: ConnectionStateChanged

• CONN_DISCONNECTED = 0

• CONN_CONNECTED = 1

• CONN_RECONNECTING = 2

Used in: RoomEvent

• required ConnectionState state = 1

Used in: RtcConfig

• GATHER_ONCE = 0

• GATHER_CONTINUALLY = 1

Create a new AudioTrack from a AudioSource

Used in: FfiRequest

• required string name = 1

• required uint64 source_handle = 2

Used in: FfiResponse

• required OwnedTrack track = 1

Create a new VideoTrack from a VideoSource

Used in: FfiRequest

• required string name = 1

• required uint64 source_handle = 2

Used in: FfiResponse

• required OwnedTrack track = 1

Used in: RoomEvent

• required DataPacketKind kind = 1

• required uint64 threshold = 2

Used in: DataChannelStats

• DC_CONNECTING = 0

• DC_OPEN = 1

• DC_CLOSING = 2

• DC_CLOSED = 3

Used in: RtcStats.DataChannel

• required string label = 1

• required string protocol = 2

• required int32 data_channel_identifier = 3

• optional DataChannelState state = 4

• required uint32 messages_sent = 5

• required uint64 bytes_sent = 6

• required uint32 messages_received = 7

• required uint64 bytes_received = 8

Used in: DataChannelBufferedAmountLowThresholdChanged, DataPacketReceived, SetDataChannelBufferedAmountLowThresholdRequest

• KIND_LOSSY = 0

• KIND_RELIABLE = 1

Used in: RoomEvent

• required DataPacketKind kind = 1

• required string participant_identity = 2

  Can be empty if the data is sent a server SDK

• oneof value

  • UserPacket user = 4

  • SipDTMF sip_dtmf = 5

(message has no fields)

header properties specific to byte or file streams

Used in: Header

• required string name = 1

Used in: DataStreamChunkReceived, SendStreamChunkRequest

• required string stream_id = 1

  unique identifier for this data stream to map it to the correct header

• required uint64 chunk_index = 2

• required bytes content = 3

  content as binary (bytes)

• optional int32 version = 4

  a version indicating that this chunk_index has been retroactively modified and the original one needs to be replaced

• optional bytes iv = 5

  optional, initialization vector for AES-GCM encryption

main DataStream.Header that contains a oneof for specific headers

Used in: DataStreamHeaderReceived, SendStreamHeaderRequest

• required string stream_id = 1

  unique identifier for this data stream

• required int64 timestamp = 2

  using int64 for Unix timestamp

• required string mime_type = 3

• required string topic = 4

• optional uint64 total_length = 5

  only populated for finite streams, if it's a stream of unknown size this stays empty

• map<string, string> attributes = 6

  user defined attributes map that can carry additional info

• oneof content_header

  oneof to choose between specific header types

  • TextHeader text_header = 7

  • ByteHeader byte_header = 8

enum for operation types (specific to TextHeader)

Used in: TextHeader

• CREATE = 0

• UPDATE = 1

• DELETE = 2

• REACTION = 3

header properties specific to text streams

Used in: Header

• required OperationType operation_type = 1

• optional int32 version = 2

  Optional: Version for updates/edits

• optional string reply_to_stream_id = 3

  Optional: Reply to specific message

• repeated string attached_stream_ids = 4

  file attachments for text streams

• optional bool generated = 5

  true if the text has been generated by an agent from a participant's audio transcription

Used in: DataStreamTrailerReceived, SendStreamTrailerRequest

• required string stream_id = 1

  unique identifier for this data stream

• required string reason = 2

  reason why the stream was closed (could contain "error" / "interrupted" / empty for expected end)

• map<string, string> attributes = 3

  finalizing updates for the stream, can also include additional insights for errors or endTime for transcription

Used in: RoomEvent

• required string participant_identity = 1

• required DataStream.Chunk chunk = 2

Used in: RoomEvent

• required string participant_identity = 1

• required DataStream.Header header = 2

Used in: RoomEvent

• required string participant_identity = 1

• required DataStream.Trailer trailer = 2

Used in: FfiEvent

• required uint64 async_id = 1

Used in: Disconnected, ParticipantDisconnected, ParticipantInfo

• UNKNOWN_REASON = 0

• CLIENT_INITIATED = 1

  the client initiated the disconnect

• DUPLICATE_IDENTITY = 2

  another participant with the same identity has joined the room

• SERVER_SHUTDOWN = 3

  the server instance is shutting down

• PARTICIPANT_REMOVED = 4

  RoomService.RemoveParticipant was called

• ROOM_DELETED = 5

  RoomService.DeleteRoom was called

• STATE_MISMATCH = 6

  the client is attempting to resume a session, but server is not aware of it

• JOIN_FAILURE = 7

  client was unable to connect fully

• MIGRATION = 8

  Cloud-only, the server requested Participant to migrate the connection elsewhere

• SIGNAL_CLOSE = 9

  the signal websocket was closed unexpectedly

• ROOM_CLOSED = 10

  the room was closed, due to all Standard and Ingress participants having left

• USER_UNAVAILABLE = 11

  SIP callee did not respond in time

• USER_REJECTED = 12

  SIP callee rejected the call (busy)

• SIP_TRUNK_FAILURE = 13

  SIP protocol failure or unexpected response

• CONNECTION_TIMEOUT = 14

Disconnect from the a room

Used in: FfiRequest

• required uint64 room_handle = 1

Used in: FfiResponse

• required uint64 async_id = 1

Used in: RoomEvent

• required DisconnectReason reason = 1

Used in: FfiEvent

• required uint64 async_id = 1

Stop all rooms synchronously (Do we need async here?). e.g: This is used for the Unity Editor after each assemblies reload. TODO(theomonnom): Implement a debug mode where we can find all leaked handles?

Used in: FfiRequest

• required bool async = 1

Used in: FfiResponse

• optional uint64 async_id = 1

  None if sync

Used in: TransportStats

• DTLS_CLIENT = 0

• DTLS_SERVER = 1

• DTLS_UNKNOWN = 2

Used in: TransportStats

• DTLS_TRANSPORT_NEW = 0

• DTLS_TRANSPORT_CONNECTING = 1

• DTLS_TRANSPORT_CONNECTED = 2

• DTLS_TRANSPORT_CLOSED = 3

• DTLS_TRANSPORT_FAILED = 4

Used in: E2eeRequest

(message has no fields)

Used in: E2eeResponse

• repeated FrameCryptor frame_cryptors = 1

Used in: E2eeRequest

• required bool enabled = 1

Used in: E2eeResponse

(message has no fields)

Used in: RoomOptions

• required EncryptionType encryption_type = 1

• required KeyProviderOptions key_provider_options = 2

Used in: FfiRequest

• required uint64 room_handle = 1

• oneof message

  • E2eeManagerSetEnabledRequest manager_set_enabled = 2

  • E2eeManagerGetFrameCryptorsRequest manager_get_frame_cryptors = 3

  • FrameCryptorSetEnabledRequest cryptor_set_enabled = 4

  • FrameCryptorSetKeyIndexRequest cryptor_set_key_index = 5

  • SetSharedKeyRequest set_shared_key = 6

  • RatchetSharedKeyRequest ratchet_shared_key = 7

  • GetSharedKeyRequest get_shared_key = 8

  • SetKeyRequest set_key = 9

  • RatchetKeyRequest ratchet_key = 10

  • GetKeyRequest get_key = 11

Used in: FfiResponse

• oneof message

  • E2eeManagerSetEnabledResponse manager_set_enabled = 1

  • E2eeManagerGetFrameCryptorsResponse manager_get_frame_cryptors = 2

  • FrameCryptorSetEnabledResponse cryptor_set_enabled = 3

  • FrameCryptorSetKeyIndexResponse cryptor_set_key_index = 4

  • SetSharedKeyResponse set_shared_key = 5

  • RatchetSharedKeyResponse ratchet_shared_key = 6

  • GetSharedKeyResponse get_shared_key = 7

  • SetKeyResponse set_key = 8

  • RatchetKeyResponse ratchet_key = 9

  • GetKeyResponse get_key = 10

Used in: RoomEvent

• required string participant_identity = 1

  Using sid instead of identity for ffi communication

• required EncryptionState state = 2

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required string edit_text = 2

• required ChatMessage original_message = 3

• repeated string destination_identities = 4

• optional string sender_identity = 5

Enable/Disable a remote track publication

Used in: FfiRequest

• required uint64 track_publication_handle = 1

• required bool enabled = 2

Used in: FfiResponse

(message has no fields)

Enable/Disable a remote track

Used in: FfiRequest

• required uint64 track_handle = 1

• required bool enabled = 2

Used in: FfiResponse

• required bool enabled = 1

Used in: E2eeStateChanged

• NEW = 0

• OK = 1

• ENCRYPTION_FAILED = 2

• DECRYPTION_FAILED = 3

• MISSING_KEY = 4

• KEY_RATCHETED = 5

• INTERNAL_ERROR = 6

Used in: E2eeOptions, TrackPublicationInfo

• NONE = 0

• GCM = 1

• CUSTOM = 2

To minimize complexity, participant events are not included in the protocol. It is easily deducible from the room events and it turned out that is is easier to implement on the ffi client side.

• oneof message

  • RoomEvent room_event = 1

  • TrackEvent track_event = 2

  • VideoStreamEvent video_stream_event = 3

  • AudioStreamEvent audio_stream_event = 4

  • ConnectCallback connect = 5

  • DisconnectCallback disconnect = 7

  • DisposeCallback dispose = 8

  • PublishTrackCallback publish_track = 9

  • UnpublishTrackCallback unpublish_track = 10

  • PublishDataCallback publish_data = 11

  • PublishTranscriptionCallback publish_transcription = 12

  • CaptureAudioFrameCallback capture_audio_frame = 13

  • SetLocalMetadataCallback set_local_metadata = 14

  • SetLocalNameCallback set_local_name = 15

  • SetLocalAttributesCallback set_local_attributes = 16

  • GetStatsCallback get_stats = 17

  • LogBatch logs = 18

  • GetSessionStatsCallback get_session_stats = 19

  • Panic panic = 20

  • PublishSipDtmfCallback publish_sip_dtmf = 21

  • SendChatMessageCallback chat_message = 22

  • PerformRpcCallback perform_rpc = 23

  • RpcMethodInvocationEvent rpc_method_invocation = 24

  • SendStreamHeaderCallback send_stream_header = 25

    Data Streams (low level)

  • SendStreamChunkCallback send_stream_chunk = 26

  • SendStreamTrailerCallback send_stream_trailer = 27

  • ByteStreamReaderEvent byte_stream_reader_event = 28

    Data Streams (high level)

  • ByteStreamReaderReadAllCallback byte_stream_reader_read_all = 29

  • ByteStreamReaderWriteToFileCallback byte_stream_reader_write_to_file = 30

  • ByteStreamOpenCallback byte_stream_open = 31

  • ByteStreamWriterWriteCallback byte_stream_writer_write = 32

  • ByteStreamWriterCloseCallback byte_stream_writer_close = 33

  • StreamSendFileCallback send_file = 34

  • TextStreamReaderEvent text_stream_reader_event = 35

  • TextStreamReaderReadAllCallback text_stream_reader_read_all = 36

  • TextStreamOpenCallback text_stream_open = 37

  • TextStreamWriterWriteCallback text_stream_writer_write = 38

  • TextStreamWriterCloseCallback text_stream_writer_close = 39

  • StreamSendTextCallback send_text = 40

# Safety The foreign language is responsable for disposing handles Forgetting to dispose the handle may lead to memory leaks Dropping a handle doesn't necessarily mean that the object is destroyed if it is still used on the FfiServer (Atomic reference counting) When refering to a handle without owning it, we just use a uint32 without this message. (the variable name is suffixed with "_handle")

Used in: OwnedApm, OwnedAudioFrameBuffer, OwnedAudioResampler, OwnedAudioSource, OwnedAudioStream, OwnedBuffer, OwnedByteStreamReader, OwnedByteStreamWriter, OwnedParticipant, OwnedRoom, OwnedSoxResampler, OwnedTextStreamReader, OwnedTextStreamWriter, OwnedTrack, OwnedTrackPublication, OwnedVideoBuffer, OwnedVideoSource, OwnedVideoStream

• required uint64 id = 1

This is the input of livekit_ffi_request function We always expect a response (FFIResponse, even if it's empty)

• oneof message

  • DisposeRequest dispose = 2

  • ConnectRequest connect = 3

    Room

  • DisconnectRequest disconnect = 4

  • PublishTrackRequest publish_track = 5

  • UnpublishTrackRequest unpublish_track = 6

  • PublishDataRequest publish_data = 7

  • SetSubscribedRequest set_subscribed = 8

  • SetLocalMetadataRequest set_local_metadata = 9

  • SetLocalNameRequest set_local_name = 10

  • SetLocalAttributesRequest set_local_attributes = 11

  • GetSessionStatsRequest get_session_stats = 12

  • PublishTranscriptionRequest publish_transcription = 13

  • PublishSipDtmfRequest publish_sip_dtmf = 14

  • CreateVideoTrackRequest create_video_track = 15

    Track

  • CreateAudioTrackRequest create_audio_track = 16

  • LocalTrackMuteRequest local_track_mute = 17

  • EnableRemoteTrackRequest enable_remote_track = 18

  • GetStatsRequest get_stats = 19

  • SetTrackSubscriptionPermissionsRequest set_track_subscription_permissions = 48

  • NewVideoStreamRequest new_video_stream = 20

    Video

  • NewVideoSourceRequest new_video_source = 21

  • CaptureVideoFrameRequest capture_video_frame = 22

  • VideoConvertRequest video_convert = 23

  • VideoStreamFromParticipantRequest video_stream_from_participant = 24

  • NewAudioStreamRequest new_audio_stream = 25

    Audio

  • NewAudioSourceRequest new_audio_source = 26

  • CaptureAudioFrameRequest capture_audio_frame = 27

  • ClearAudioBufferRequest clear_audio_buffer = 28

  • NewAudioResamplerRequest new_audio_resampler = 29

  • RemixAndResampleRequest remix_and_resample = 30

  • E2eeRequest e2ee = 31

  • AudioStreamFromParticipantRequest audio_stream_from_participant = 32

  • NewSoxResamplerRequest new_sox_resampler = 33

  • PushSoxResamplerRequest push_sox_resampler = 34

  • FlushSoxResamplerRequest flush_sox_resampler = 35

  • SendChatMessageRequest send_chat_message = 36

  • EditChatMessageRequest edit_chat_message = 37

  • PerformRpcRequest perform_rpc = 38

    RPC

  • RegisterRpcMethodRequest register_rpc_method = 39

  • UnregisterRpcMethodRequest unregister_rpc_method = 40

  • RpcMethodInvocationResponseRequest rpc_method_invocation_response = 41

  • EnableRemoteTrackPublicationRequest enable_remote_track_publication = 42

    Track Publication

  • UpdateRemoteTrackPublicationDimensionRequest update_remote_track_publication_dimension = 43

  • SendStreamHeaderRequest send_stream_header = 44

    Data Streams (low level)

  • SendStreamChunkRequest send_stream_chunk = 45

  • SendStreamTrailerRequest send_stream_trailer = 46

  • SetDataChannelBufferedAmountLowThresholdRequest set_data_channel_buffered_amount_low_threshold = 47

    Data Channel

  • LoadAudioFilterPluginRequest load_audio_filter_plugin = 49

    Audio Filter Plugin

  • NewApmRequest new_apm = 50

  • ApmProcessStreamRequest apm_process_stream = 51

  • ApmProcessReverseStreamRequest apm_process_reverse_stream = 52

  • ApmSetStreamDelayRequest apm_set_stream_delay = 53

  • ByteStreamReaderReadIncrementalRequest byte_read_incremental = 54

    Data Streams (high level)

  • ByteStreamReaderReadAllRequest byte_read_all = 55

  • ByteStreamReaderWriteToFileRequest byte_write_to_file = 56

  • TextStreamReaderReadIncrementalRequest text_read_incremental = 57

  • TextStreamReaderReadAllRequest text_read_all = 58

  • StreamSendFileRequest send_file = 59

  • StreamSendTextRequest send_text = 60

  • ByteStreamOpenRequest byte_stream_open = 61

  • ByteStreamWriterWriteRequest byte_stream_write = 62

  • ByteStreamWriterCloseRequest byte_stream_close = 63

  • TextStreamOpenRequest text_stream_open = 64

  • TextStreamWriterWriteRequest text_stream_write = 65

  • TextStreamWriterCloseRequest text_stream_close = 66

This is the output of livekit_ffi_request function.

• oneof message

  • DisposeResponse dispose = 2

  • ConnectResponse connect = 3

    Room

  • DisconnectResponse disconnect = 4

  • PublishTrackResponse publish_track = 5

  • UnpublishTrackResponse unpublish_track = 6

  • PublishDataResponse publish_data = 7

  • SetSubscribedResponse set_subscribed = 8

  • SetLocalMetadataResponse set_local_metadata = 9

  • SetLocalNameResponse set_local_name = 10

  • SetLocalAttributesResponse set_local_attributes = 11

  • GetSessionStatsResponse get_session_stats = 12

  • PublishTranscriptionResponse publish_transcription = 13

  • PublishSipDtmfResponse publish_sip_dtmf = 14

  • CreateVideoTrackResponse create_video_track = 15

    Track

  • CreateAudioTrackResponse create_audio_track = 16

  • LocalTrackMuteResponse local_track_mute = 17

  • EnableRemoteTrackResponse enable_remote_track = 18

  • GetStatsResponse get_stats = 19

  • SetTrackSubscriptionPermissionsResponse set_track_subscription_permissions = 47

  • NewVideoStreamResponse new_video_stream = 20

    Video

  • NewVideoSourceResponse new_video_source = 21

  • CaptureVideoFrameResponse capture_video_frame = 22

  • VideoConvertResponse video_convert = 23

  • VideoStreamFromParticipantResponse video_stream_from_participant = 24

  • NewAudioStreamResponse new_audio_stream = 25

    Audio

  • NewAudioSourceResponse new_audio_source = 26

  • CaptureAudioFrameResponse capture_audio_frame = 27

  • ClearAudioBufferResponse clear_audio_buffer = 28

  • NewAudioResamplerResponse new_audio_resampler = 29

  • RemixAndResampleResponse remix_and_resample = 30

  • AudioStreamFromParticipantResponse audio_stream_from_participant = 31

  • E2eeResponse e2ee = 32

  • NewSoxResamplerResponse new_sox_resampler = 33

  • PushSoxResamplerResponse push_sox_resampler = 34

  • FlushSoxResamplerResponse flush_sox_resampler = 35

  • SendChatMessageResponse send_chat_message = 36

  • PerformRpcResponse perform_rpc = 37

    RPC

  • RegisterRpcMethodResponse register_rpc_method = 38

  • UnregisterRpcMethodResponse unregister_rpc_method = 39

  • RpcMethodInvocationResponseResponse rpc_method_invocation_response = 40

  • EnableRemoteTrackPublicationResponse enable_remote_track_publication = 41

    Track Publication

  • UpdateRemoteTrackPublicationDimensionResponse update_remote_track_publication_dimension = 42

  • SendStreamHeaderResponse send_stream_header = 43

    Data Streams

  • SendStreamChunkResponse send_stream_chunk = 44

  • SendStreamTrailerResponse send_stream_trailer = 45

  • SetDataChannelBufferedAmountLowThresholdResponse set_data_channel_buffered_amount_low_threshold = 46

    Data Channel

  • LoadAudioFilterPluginResponse load_audio_filter_plugin = 48

    Audio Filter Plugin

  • NewApmResponse new_apm = 49

  • ApmProcessStreamResponse apm_process_stream = 50

  • ApmProcessReverseStreamResponse apm_process_reverse_stream = 51

  • ApmSetStreamDelayResponse apm_set_stream_delay = 52

  • ByteStreamReaderReadIncrementalResponse byte_read_incremental = 53

    Data Streams (high level)

  • ByteStreamReaderReadAllResponse byte_read_all = 54

  • ByteStreamReaderWriteToFileResponse byte_write_to_file = 55

  • TextStreamReaderReadIncrementalResponse text_read_incremental = 56

  • TextStreamReaderReadAllResponse text_read_all = 57

  • StreamSendFileResponse send_file = 58

  • StreamSendTextResponse send_text = 59

  • ByteStreamOpenResponse byte_stream_open = 60

  • ByteStreamWriterWriteResponse byte_stream_write = 61

  • ByteStreamWriterCloseResponse byte_stream_close = 62

  • TextStreamOpenResponse text_stream_open = 63

  • TextStreamWriterWriteResponse text_stream_write = 64

  • TextStreamWriterCloseResponse text_stream_close = 65

Used in: FfiRequest

• required uint64 resampler_handle = 1

Used in: FfiResponse

• required uint64 output_ptr = 1

  *const i16 (could be null)

• required uint32 size = 2

  in bytes

• optional string error = 3

Used in: E2eeManagerGetFrameCryptorsResponse

• required string participant_identity = 1

• required string track_sid = 2

• required int32 key_index = 3

• required bool enabled = 4

Used in: E2eeRequest

• required string participant_identity = 1

• required string track_sid = 2

• required bool enabled = 3

Used in: E2eeResponse

(message has no fields)

Used in: E2eeRequest

• required string participant_identity = 1

• required string track_sid = 2

• required int32 key_index = 3

Used in: E2eeResponse

(message has no fields)

Used in: E2eeRequest

• required string participant_identity = 1

• required int32 key_index = 2

Used in: E2eeResponse

• optional bytes key = 1

Used in: FfiEvent

• required uint64 async_id = 1

• oneof message

  • string error = 2

  • GetSessionStatsCallback.Result result = 3

Used in: GetSessionStatsCallback

• repeated RtcStats publisher_stats = 1

• repeated RtcStats subscriber_stats = 2

Used in: FfiRequest

• required uint64 room_handle = 1

Used in: FfiResponse

• required uint64 async_id = 1

Used in: E2eeRequest

• required int32 key_index = 1

Used in: E2eeResponse

• optional bytes key = 1

Used in: FfiEvent

• required uint64 async_id = 1

• optional string error = 2

• repeated RtcStats stats = 3

Used in: FfiRequest

• required uint64 track_handle = 1

Used in: FfiResponse

• required uint64 async_id = 1

Used in: CandidatePairStats

• PAIR_FROZEN = 0

• PAIR_WAITING = 1

• PAIR_IN_PROGRESS = 2

• PAIR_FAILED = 3

• PAIR_SUCCEEDED = 4

Used in: RtcStats.LocalCandidate, RtcStats.RemoteCandidate

• required string transport_id = 1

• required string address = 2

• required int32 port = 3

• required string protocol = 4

• optional IceCandidateType candidate_type = 5

• required int32 priority = 6

• required string url = 7

• optional IceServerTransportProtocol relay_protocol = 8

• required string foundation = 9

• required string related_address = 10

• required int32 related_port = 11

• required string username_fragment = 12

• optional IceTcpCandidateType tcp_type = 13

Used in: IceCandidateStats

• HOST = 0

• SRFLX = 1

• PRFLX = 2

• RELAY = 3

Used in: TransportStats

• ICE_UNKNOWN = 0

• ICE_CONTROLLING = 1

• ICE_CONTROLLED = 2

Used in: RtcConfig

• repeated string urls = 1

• optional string username = 2

• optional string password = 3

Used in: IceCandidateStats

• TRANSPORT_UDP = 0

• TRANSPORT_TCP = 1

• TRANSPORT_TLS = 2

Used in: IceCandidateStats

• CANDIDATE_ACTIVE = 0

• CANDIDATE_PASSIVE = 1

• CANDIDATE_SO = 2

Used in: TransportStats

• ICE_TRANSPORT_NEW = 0

• ICE_TRANSPORT_CHECKING = 1

• ICE_TRANSPORT_CONNECTED = 2

• ICE_TRANSPORT_COMPLETED = 3

• ICE_TRANSPORT_DISCONNECTED = 4

• ICE_TRANSPORT_FAILED = 5

• ICE_TRANSPORT_CLOSED = 6

Used in: RtcConfig

• TRANSPORT_RELAY = 0

• TRANSPORT_NOHOST = 1

• TRANSPORT_ALL = 2

Used in: RtcStats.InboundRtp

• required string track_identifier = 1

• required string mid = 2

• required string remote_id = 3

• required uint32 frames_decoded = 4

• required uint32 key_frames_decoded = 5

• required uint32 frames_rendered = 6

• required uint32 frames_dropped = 7

• required uint32 frame_width = 8

• required uint32 frame_height = 9

• required double frames_per_second = 10

• required uint64 qp_sum = 11

• required double total_decode_time = 12

• required double total_inter_frame_delay = 13

• required double total_squared_inter_frame_delay = 14

• required uint32 pause_count = 15

• required double total_pause_duration = 16

• required uint32 freeze_count = 17

• required double total_freeze_duration = 18

• required double last_packet_received_timestamp = 19

• required uint64 header_bytes_received = 20

• required uint64 packets_discarded = 21

• required uint64 fec_bytes_received = 22

• required uint64 fec_packets_received = 23

• required uint64 fec_packets_discarded = 24

• required uint64 bytes_received = 25

• required uint32 nack_count = 26

• required uint32 fir_count = 27

• required uint32 pli_count = 28

• required double total_processing_delay = 29

• required double estimated_playout_timestamp = 30

• required double jitter_buffer_delay = 31

• required double jitter_buffer_target_delay = 32

• required uint64 jitter_buffer_emitted_count = 33

• required double jitter_buffer_minimum_delay = 34

• required uint64 total_samples_received = 35

• required uint64 concealed_samples = 36

• required uint64 silent_concealed_samples = 37

• required uint64 concealment_events = 38

• required uint64 inserted_samples_for_deceleration = 39

• required uint64 removed_samples_for_acceleration = 40

• required double audio_level = 41

• required double total_audio_energy = 42

• required double total_samples_duration = 43

• required uint64 frames_received = 44

• required string decoder_implementation = 45

• required string playout_id = 46

• required bool power_efficient_decoder = 47

• required uint64 frames_assembled_from_multiple_packets = 48

• required double total_assembly_time = 49

• required uint64 retransmitted_packets_received = 50

• required uint64 retransmitted_bytes_received = 51

• required uint32 rtx_ssrc = 52

• required uint32 fec_ssrc = 53

Used in: E2eeOptions

• optional bytes shared_key = 1

  Only specify if you want to use a shared_key

• required int32 ratchet_window_size = 2

• required bytes ratchet_salt = 3

• required int32 failure_tolerance = 4

  -1 = no tolerance

Audio Filter Plugin

Used in: FfiRequest

• required string plugin_path = 1

  path for ffi audio filter plugin

• repeated string dependencies = 2

  Optional: paths for dependency dylibs

• required string module_id = 3

  Unique identifier of the plugin

Used in: FfiResponse

• optional string error = 1

Mute/UnMute a track

Used in: FfiRequest

• required uint64 track_handle = 1

• required bool mute = 2

Used in: FfiResponse

• required bool muted = 1

Used in: RoomEvent

• required string track_sid = 1

  The TrackPublicationInfo comes from the PublishTrack response and the FfiClient musts wait for it before firing this event

Used in: RoomEvent

• required string track_sid = 2

Used in: RoomEvent

• required string publication_sid = 1

Used in: FfiEvent

• repeated LogRecord records = 1

Used in: LogRecord

• LOG_ERROR = 0

• LOG_WARN = 1

• LOG_INFO = 2

• LOG_DEBUG = 3

• LOG_TRACE = 4

Used in: LogBatch

• required LogLevel level = 1

• required string target = 2

  e.g "livekit", "libwebrtc", "tokio-tungstenite", etc...

• optional string module_path = 3

• optional string file = 4

• optional uint32 line = 5

• required string message = 6

Used in: RtcStats.MediaSource

• required string track_identifier = 1

• required string kind = 2

Used in: FfiRequest

• required bool echo_canceller_enabled = 1

• required bool gain_controller_enabled = 2

• required bool high_pass_filter_enabled = 3

• required bool noise_suppression_enabled = 4

Used in: FfiResponse

• required OwnedApm apm = 1

Create a new AudioResampler

Used in: FfiRequest

(message has no fields)

Used in: FfiResponse

• required OwnedAudioResampler resampler = 1

Create a new AudioSource

Used in: FfiRequest

• required AudioSourceType type = 1

• optional AudioSourceOptions options = 2

• required uint32 sample_rate = 3

• required uint32 num_channels = 4

• optional uint32 queue_size_ms = 5

Used in: FfiResponse

• required OwnedAudioSource source = 1

Create a new AudioStream AudioStream is used to receive audio frames from a track

Used in: FfiRequest

• required uint64 track_handle = 1

• required AudioStreamType type = 2

• optional uint32 sample_rate = 3

• optional uint32 num_channels = 4

• optional string audio_filter_module_id = 5

  Unique identifier passed in LoadAudioFilterPluginRequest

• optional string audio_filter_options = 6

Used in: FfiResponse

• required OwnedAudioStream stream = 1

Used in: FfiRequest

• required double input_rate = 1

• required double output_rate = 2

• required uint32 num_channels = 3

• required SoxResamplerDataType input_data_type = 4

• required SoxResamplerDataType output_data_type = 5

• required SoxQualityRecipe quality_recipe = 6

• optional uint32 flags = 7

Used in: FfiResponse

• oneof message

  • OwnedSoxResampler resampler = 1

  • string error = 2

Create a new VideoSource VideoSource is used to send video frame to a track

Used in: FfiRequest

• required VideoSourceType type = 1

• required VideoSourceResolution resolution = 2

  Used to determine which encodings to use + simulcast layers Most of the time it corresponds to the source resolution

Used in: FfiResponse

• required OwnedVideoSource source = 1

Create a new VideoStream VideoStream is used to receive video frames from a track

Used in: FfiRequest

• required uint64 track_handle = 1

• required VideoStreamType type = 2

• optional VideoBufferType format = 3

  Get the frame on a specific format

• optional bool normalize_stride = 4

  if true, stride will be set to width/chroma_width

Used in: FfiResponse

• required OwnedVideoStream stream = 1

Used in: RtcStats.OutboundRtp

• required string mid = 1

• required string media_source_id = 2

• required string remote_id = 3

• required string rid = 4

• required uint64 header_bytes_sent = 5

• required uint64 retransmitted_packets_sent = 6

• required uint64 retransmitted_bytes_sent = 7

• required uint32 rtx_ssrc = 8

• required double target_bitrate = 9

• required uint64 total_encoded_bytes_target = 10

• required uint32 frame_width = 11

• required uint32 frame_height = 12

• required double frames_per_second = 13

• required uint32 frames_sent = 14

• required uint32 huge_frames_sent = 15

• required uint32 frames_encoded = 16

• required uint32 key_frames_encoded = 17

• required uint64 qp_sum = 18

• required double total_encode_time = 19

• required double total_packet_send_delay = 20

• required QualityLimitationReason quality_limitation_reason = 21

• map<string, double> quality_limitation_durations = 22

• required uint32 quality_limitation_resolution_changes = 23

• required uint32 nack_count = 24

• required uint32 fir_count = 25

• required uint32 pli_count = 26

• required string encoder_implementation = 27

• required bool power_efficient_encoder = 28

• required bool active = 29

• required string scalability_mode = 30

Used in: NewApmResponse

• required FfiOwnedHandle handle = 1

Used in: AudioFrameReceived, RemixAndResampleResponse

• required FfiOwnedHandle handle = 1

• required AudioFrameBufferInfo info = 2

Used in: NewAudioResamplerResponse

• required FfiOwnedHandle handle = 1

• required AudioResamplerInfo info = 2

Used in: NewAudioSourceResponse

• required FfiOwnedHandle handle = 1

• required AudioSourceInfo info = 2

Used in: AudioStreamFromParticipantResponse, NewAudioStreamResponse

• required FfiOwnedHandle handle = 1

• required AudioStreamInfo info = 2

Used in: UserPacket

• required FfiOwnedHandle handle = 1

• required BufferInfo data = 2

A reader for an incoming stream.

Used in: ByteStreamOpened

• required FfiOwnedHandle handle = 1

• required ByteStreamInfo info = 2

Used in: ByteStreamOpenCallback

• required FfiOwnedHandle handle = 1

• required ByteStreamInfo info = 2

Used in: ConnectCallback.ParticipantWithTracks, ConnectCallback.Result, ParticipantConnected

• required FfiOwnedHandle handle = 1

• required ParticipantInfo info = 2

Used in: ConnectCallback.Result

• required FfiOwnedHandle handle = 1

• required RoomInfo info = 2

Used in: NewSoxResamplerResponse

• required FfiOwnedHandle handle = 1

• required SoxResamplerInfo info = 2

A reader for an incoming stream.

Used in: TextStreamOpened

• required FfiOwnedHandle handle = 1

• required TextStreamInfo info = 2

Used in: TextStreamOpenCallback

• required FfiOwnedHandle handle = 1

• required TextStreamInfo info = 2

Used in: CreateAudioTrackResponse, CreateVideoTrackResponse, TrackSubscribed

• required FfiOwnedHandle handle = 1

• required TrackInfo info = 2

Used in: ConnectCallback.ParticipantWithTracks, PublishTrackCallback, TrackPublished

• required FfiOwnedHandle handle = 1

• required TrackPublicationInfo info = 2

Used in: VideoConvertResponse, VideoFrameReceived

• required FfiOwnedHandle handle = 1

• required VideoBufferInfo info = 2

Used in: NewVideoSourceResponse

• required FfiOwnedHandle handle = 1

• required VideoSourceInfo info = 2

Used in: NewVideoStreamResponse, VideoStreamFromParticipantResponse

• required FfiOwnedHandle handle = 1

• required VideoStreamInfo info = 2

Used in: FfiEvent

• required string message = 1

Used in: RoomEvent

• required string participant_identity = 1

• repeated AttributesEntry attributes = 2

• repeated AttributesEntry changed_attributes = 3

Used in: RoomEvent

• required OwnedParticipant info = 1

Used in: RoomEvent

• required string participant_identity = 1

• required DisconnectReason disconnect_reason = 2

Used in: OwnedParticipant

• required string sid = 1

• required string name = 2

• required string identity = 3

• required string metadata = 4

• map<string, string> attributes = 5

• required ParticipantKind kind = 6

• required DisconnectReason disconnect_reason = 7

Used in: ParticipantInfo

• PARTICIPANT_KIND_STANDARD = 0

• PARTICIPANT_KIND_INGRESS = 1

• PARTICIPANT_KIND_EGRESS = 2

• PARTICIPANT_KIND_SIP = 3

• PARTICIPANT_KIND_AGENT = 4

Used in: RoomEvent

• required string participant_identity = 1

• required string metadata = 2

Used in: RoomEvent

• required string participant_identity = 1

• required string name = 2

Used in: SetTrackSubscriptionPermissionsRequest

• required string participant_identity = 1

  The participant identity this permission applies to.

• optional bool allow_all = 2

  Grant permission to all all tracks. Takes precedence over allowedTrackSids.

• repeated string allowed_track_sids = 3

  List of track sids to grant permission to.

Used in: RtcStats.PeerConnection

• required uint32 data_channels_opened = 1

• required uint32 data_channels_closed = 2

FFI Callbacks

Used in: FfiEvent

• required uint64 async_id = 1

• optional string payload = 2

• optional RpcError error = 3

FFI Requests

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required string destination_identity = 2

• required string method = 3

• required string payload = 4

• optional uint32 response_timeout_ms = 5

FFI Responses

Used in: FfiResponse

• required uint64 async_id = 1

Used in: FfiEvent

• required uint64 async_id = 1

• optional string error = 2

Publish data to other participants

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required uint64 data_ptr = 2

• required uint64 data_len = 3

• required bool reliable = 4

• repeated string destination_sids = 5

• optional string topic = 6

• repeated string destination_identities = 7

Used in: FfiResponse

• required uint64 async_id = 1

Used in: FfiEvent

• required uint64 async_id = 1

• optional string error = 2

Publish Sip DTMF messages to other participants

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required uint32 code = 2

• required string digit = 3

• repeated string destination_identities = 4

Used in: FfiResponse

• required uint64 async_id = 1

Used in: FfiEvent

• required uint64 async_id = 1

• oneof message

  • string error = 2

  • OwnedTrackPublication publication = 3

Publish a track to the room

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required uint64 track_handle = 2

• required TrackPublishOptions options = 3

Used in: FfiResponse

• required uint64 async_id = 1

Used in: FfiEvent

• required uint64 async_id = 1

• optional string error = 2

Publish transcription messages to room

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required string participant_identity = 2

• required string track_id = 3

• repeated TranscriptionSegment segments = 4

Used in: FfiResponse

• required uint64 async_id = 1

Used in: FfiRequest

• required uint64 resampler_handle = 1

• required uint64 data_ptr = 2

  *const i16

• required uint32 size = 3

  in bytes

Used in: FfiResponse

• required uint64 output_ptr = 1

  *const i16 (could be null)

• required uint32 size = 2

  in bytes

• optional string error = 3

Used in: OutboundRtpStreamStats

• LIMITATION_NONE = 0

• LIMITATION_CPU = 1

• LIMITATION_BANDWIDTH = 2

• LIMITATION_OTHER = 3

Used in: E2eeRequest

• required string participant_identity = 1

• required int32 key_index = 2

Used in: E2eeResponse

• optional bytes new_key = 1

Used in: E2eeRequest

• required int32 key_index = 1

Used in: E2eeResponse

• optional bytes new_key = 1

Used in: RtcStats.InboundRtp, RtcStats.RemoteInboundRtp

• required uint64 packets_received = 1

• required int64 packets_lost = 2

• required double jitter = 3

Used in: RoomEvent

(message has no fields)

Used in: RoomEvent

(message has no fields)

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required string method = 2

Used in: FfiResponse

(message has no fields)

Remix and resample an audio frame

Used in: FfiRequest

• required uint64 resampler_handle = 1

• required AudioFrameBufferInfo buffer = 2

• required uint32 num_channels = 3

• required uint32 sample_rate = 4

Used in: FfiResponse

• required OwnedAudioFrameBuffer buffer = 1

Used in: RtcStats.RemoteInboundRtp

• required string local_id = 1

• required double round_trip_time = 2

• required double total_round_trip_time = 3

• required double fraction_lost = 4

• required uint64 round_trip_time_measurements = 5

Used in: RtcStats.RemoteOutboundRtp

• required string local_id = 1

• required double remote_timestamp = 2

• required uint64 reports_sent = 3

• required double round_trip_time = 4

• required double total_round_trip_time = 5

• required uint64 round_trip_time_measurements = 6

Used in: RoomEvent

(message has no fields)

Used in: FfiEvent

• required uint64 room_handle = 1

• oneof message

  • ParticipantConnected participant_connected = 2

  • ParticipantDisconnected participant_disconnected = 3

  • LocalTrackPublished local_track_published = 4

  • LocalTrackUnpublished local_track_unpublished = 5

  • LocalTrackSubscribed local_track_subscribed = 6

  • TrackPublished track_published = 7

  • TrackUnpublished track_unpublished = 8

  • TrackSubscribed track_subscribed = 9

  • TrackUnsubscribed track_unsubscribed = 10

  • TrackSubscriptionFailed track_subscription_failed = 11

  • TrackMuted track_muted = 12

  • TrackUnmuted track_unmuted = 13

  • ActiveSpeakersChanged active_speakers_changed = 14

  • RoomMetadataChanged room_metadata_changed = 15

  • RoomSidChanged room_sid_changed = 16

  • ParticipantMetadataChanged participant_metadata_changed = 17

  • ParticipantNameChanged participant_name_changed = 18

  • ParticipantAttributesChanged participant_attributes_changed = 19

  • ConnectionQualityChanged connection_quality_changed = 20

  • ConnectionStateChanged connection_state_changed = 21

  • Disconnected disconnected = 22

    Connected connected = 21;

  • Reconnecting reconnecting = 23

  • Reconnected reconnected = 24

  • E2eeStateChanged e2ee_state_changed = 25

  • RoomEOS eos = 26

    The stream of room events has ended

  • DataPacketReceived data_packet_received = 27

  • TranscriptionReceived transcription_received = 28

  • ChatMessageReceived chat_message = 29

  • DataStreamHeaderReceived stream_header_received = 30

    Data stream (low level)

  • DataStreamChunkReceived stream_chunk_received = 31

  • DataStreamTrailerReceived stream_trailer_received = 32

  • DataChannelBufferedAmountLowThresholdChanged data_channel_low_threshold_changed = 33

  • ByteStreamOpened byte_stream_opened = 34

    Data stream (high level)

  • TextStreamOpened text_stream_opened = 35

Used in: OwnedRoom

• optional string sid = 1

• required string name = 2

• required string metadata = 3

• required uint64 lossy_dc_buffered_amount_low_threshold = 4

• required uint64 reliable_dc_buffered_amount_low_threshold = 5

Used in: RoomEvent

• required string metadata = 1

Used in: ConnectRequest

• optional bool auto_subscribe = 1

• optional bool adaptive_stream = 2

• optional bool dynacast = 3

• optional E2eeOptions e2ee = 4

• optional RtcConfig rtc_config = 5

  allow to setup a custom RtcConfiguration

• optional uint32 join_retries = 6

Used in: RoomEvent

• required string sid = 1

Used in: PerformRpcCallback, RpcMethodInvocationResponseRequest

• required uint32 code = 1

• required string message = 2

• optional string data = 3

FFI Events

Used in: FfiEvent

• required uint64 local_participant_handle = 1

• required uint64 invocation_id = 2

• required string method = 3

• required string request_id = 4

• required string caller_identity = 5

• required string payload = 6

• required uint32 response_timeout_ms = 7

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required uint64 invocation_id = 2

• optional string payload = 3

• optional RpcError error = 4

Used in: FfiResponse

• optional string error = 1

Used in: RoomOptions

• optional IceTransportType ice_transport_type = 1

• optional ContinualGatheringPolicy continual_gathering_policy = 2

• repeated IceServer ice_servers = 3

  empty fallback to default

Used in: GetSessionStatsCallback.Result, GetStatsCallback

• oneof stats

  • RtcStats.Codec codec = 3

  • RtcStats.InboundRtp inbound_rtp = 4

  • RtcStats.OutboundRtp outbound_rtp = 5

  • RtcStats.RemoteInboundRtp remote_inbound_rtp = 6

  • RtcStats.RemoteOutboundRtp remote_outbound_rtp = 7

  • RtcStats.MediaSource media_source = 8

  • RtcStats.MediaPlayout media_playout = 9

  • RtcStats.PeerConnection peer_connection = 10

  • RtcStats.DataChannel data_channel = 11

  • RtcStats.Transport transport = 12

  • RtcStats.CandidatePair candidate_pair = 13

  • RtcStats.LocalCandidate local_candidate = 14

  • RtcStats.RemoteCandidate remote_candidate = 15

  • RtcStats.Certificate certificate = 16

  • RtcStats.Stream stream = 17

  • RtcStats.Track track = 18

Used in: RtcStats

• required RtcStatsData rtc = 1

• required CandidatePairStats candidate_pair = 2

Used in: RtcStats

• required RtcStatsData rtc = 1

• required CertificateStats certificate = 2

Used in: RtcStats

• required RtcStatsData rtc = 1

• required CodecStats codec = 2

Used in: RtcStats

• required RtcStatsData rtc = 1

• required DataChannelStats dc = 2

Used in: RtcStats

• required RtcStatsData rtc = 1

• required RtpStreamStats stream = 2

• required ReceivedRtpStreamStats received = 3

• required InboundRtpStreamStats inbound = 4

Used in: RtcStats

• required RtcStatsData rtc = 1

• required IceCandidateStats candidate = 2

Used in: RtcStats

• required RtcStatsData rtc = 1

• required AudioPlayoutStats audio_playout = 2

Used in: RtcStats

• required RtcStatsData rtc = 1

• required MediaSourceStats source = 2

• required AudioSourceStats audio = 3

• required VideoSourceStats video = 4

Used in: RtcStats

• required RtcStatsData rtc = 1

• required RtpStreamStats stream = 2

• required SentRtpStreamStats sent = 3

• required OutboundRtpStreamStats outbound = 4

Used in: RtcStats

• required RtcStatsData rtc = 1

• required PeerConnectionStats pc = 2

Used in: RtcStats

• required RtcStatsData rtc = 1

• required IceCandidateStats candidate = 2

Used in: RtcStats

• required RtcStatsData rtc = 1

• required RtpStreamStats stream = 2

• required ReceivedRtpStreamStats received = 3

• required RemoteInboundRtpStreamStats remote_inbound = 4

Used in: RtcStats

• required RtcStatsData rtc = 1

• required RtpStreamStats stream = 2

• required SentRtpStreamStats sent = 3

• required RemoteOutboundRtpStreamStats remote_outbound = 4

Used in: RtcStats

• required RtcStatsData rtc = 1

• required StreamStats stream = 2

Deprecated

Used in: RtcStats

(message has no fields)

Used in: RtcStats

• required RtcStatsData rtc = 1

• required TransportStats transport = 2

Used in: RtcStats.CandidatePair, RtcStats.Certificate, RtcStats.Codec, RtcStats.DataChannel, RtcStats.InboundRtp, RtcStats.LocalCandidate, RtcStats.MediaPlayout, RtcStats.MediaSource, RtcStats.OutboundRtp, RtcStats.PeerConnection, RtcStats.RemoteCandidate, RtcStats.RemoteInboundRtp, RtcStats.RemoteOutboundRtp, RtcStats.Stream, RtcStats.Transport

• required string id = 1

• required int64 timestamp = 2

Used in: RtcStats.InboundRtp, RtcStats.OutboundRtp, RtcStats.RemoteInboundRtp, RtcStats.RemoteOutboundRtp

• required uint32 ssrc = 1

• required string kind = 2

• required string transport_id = 3

• required string codec_id = 4

Used in: FfiEvent

• required uint64 async_id = 1

• oneof message

  • string error = 2

  • ChatMessage chat_message = 3

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required string message = 2

• repeated string destination_identities = 3

• optional string sender_identity = 4

Used in: FfiResponse

• required uint64 async_id = 1

Used in: FfiEvent

• required uint64 async_id = 1

• optional string error = 2

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required DataStream.Chunk chunk = 2

• repeated string destination_identities = 3

• required string sender_identity = 4

Used in: FfiResponse

• required uint64 async_id = 1

Used in: FfiEvent

• required uint64 async_id = 1

• optional string error = 2

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required DataStream.Header header = 2

• repeated string destination_identities = 3

• required string sender_identity = 4

Used in: FfiResponse

• required uint64 async_id = 1

Used in: FfiEvent

• required uint64 async_id = 1

• optional string error = 2

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required DataStream.Trailer trailer = 2

• repeated string destination_identities = 3

• required string sender_identity = 4

Used in: FfiResponse

• required uint64 async_id = 1

Used in: RtcStats.OutboundRtp, RtcStats.RemoteOutboundRtp

• required uint64 packets_sent = 1

• required uint64 bytes_sent = 2

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required uint64 threshold = 2

• required DataPacketKind kind = 3

Used in: FfiResponse

(message has no fields)

Used in: E2eeRequest

• required string participant_identity = 1

• required bytes key = 2

• required int32 key_index = 3

Used in: E2eeResponse

(message has no fields)

Used in: FfiEvent

• required uint64 async_id = 1

• optional string error = 2

Change the local participant's attributes

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• repeated AttributesEntry attributes = 2

Used in: FfiResponse

• required uint64 async_id = 1

Used in: FfiEvent

• required uint64 async_id = 1

• optional string error = 2

Change the local participant's metadata

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required string metadata = 2

Used in: FfiResponse

• required uint64 async_id = 1

Used in: FfiEvent

• required uint64 async_id = 1

• optional string error = 2

Change the local participant's name

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required string name = 2

Used in: FfiResponse

• required uint64 async_id = 1

Used in: E2eeRequest

• required bytes shared_key = 1

• required int32 key_index = 2

Used in: E2eeResponse

(message has no fields)

Change the "desire" to subs2ribe to a track

Used in: FfiRequest

• required bool subscribe = 1

• required uint64 publication_handle = 2

Used in: FfiResponse

(message has no fields)

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required bool all_participants_allowed = 2

• repeated ParticipantTrackPermission permissions = 3

Used in: FfiResponse

(message has no fields)

Used in: DataPacketReceived

• required uint32 code = 1

• optional string digit = 2

• SOXR_ROLLOFF_SMALL = 0

  1 << 0

• SOXR_ROLLOFF_MEDIUM = 1

  1 << 1

• SOXR_ROLLOFF_NONE = 2

  1 << 2

• SOXR_HIGH_PREC_CLOCK = 3

  1 << 3

• SOXR_DOUBLE_PRECISION = 4

  1 << 4

• SOXR_VR = 5

  1 << 5

Used in: NewSoxResamplerRequest

• SOXR_QUALITY_QUICK = 0

• SOXR_QUALITY_LOW = 1

• SOXR_QUALITY_MEDIUM = 2

• SOXR_QUALITY_HIGH = 3

• SOXR_QUALITY_VERYHIGH = 4

Used in: NewSoxResamplerRequest

• SOXR_DATATYPE_INT16I = 0

  TODO(theomonnom): support other datatypes (shouldn't really be needed)

• SOXR_DATATYPE_INT16S = 1

Used in: OwnedSoxResampler

(message has no fields)

Used in: ByteStreamOpenRequest, StreamSendFileRequest

• required string topic = 1

• map<string, string> attributes = 2

• repeated string destination_identities = 3

• optional string id = 4

• optional string name = 5

• optional string mime_type = 6

• optional uint64 total_length = 7

Error pertaining to a stream.

Used in: ByteStreamOpenCallback, ByteStreamReaderEOS, ByteStreamReaderReadAllCallback, ByteStreamReaderWriteToFileCallback, ByteStreamWriterCloseCallback, ByteStreamWriterWriteCallback, StreamSendFileCallback, StreamSendTextCallback, TextStreamOpenCallback, TextStreamReaderEOS, TextStreamReaderReadAllCallback, TextStreamWriterCloseCallback, TextStreamWriterWriteCallback

• required string description = 1

  TODO(ladvoc): make this an enum.

Used in: FfiEvent

• required uint64 async_id = 1

• oneof result

  • ByteStreamInfo info = 2

  • StreamError error = 3

Sends the contents of a file over a data stream.

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required StreamByteOptions options = 2

• required string file_path = 3

  Path of the file to send (must be readable by the current process).

Used in: FfiResponse

• required uint64 async_id = 1

Used in: FfiEvent

• required uint64 async_id = 1

• oneof result

  • TextStreamInfo info = 2

  • StreamError error = 3

Sends text over a data stream.

Used in: FfiRequest

• required uint64 local_participant_handle = 1

• required StreamTextOptions options = 2

• required string text = 3

  Text to send.

Used in: FfiResponse

• required uint64 async_id = 1

Used in: TrackInfo

• STATE_UNKNOWN = 0

• STATE_ACTIVE = 1

• STATE_PAUSED = 2

Used in: RtcStats.Stream

• required string id = 1

• required string stream_identifier = 2

  required int64 timestamp = 3;

Used in: StreamSendTextRequest, TextStreamOpenRequest