Data tracks FFI interface

.changeset/initial_support_for_data_tracks_ffi.md

@@ -0,0 +1,5 @@
+---
+livekit-ffi: minor
+---
+
+# Initial support for data tracks

livekit-ffi-node-bindings/proto/audio_frame_pb.d.ts

@@ -191,6 +191,11 @@ export declare class NewAudioStreamRequest extends Message<NewAudioStreamRequest
    * default bounded queue size of 10 frames. Set it to 0 to request unbounded
    * buffering.
    *
+   * If your application consumes both audio and video, keep the queue sizing
+   * strategy coordinated across both streams. Using a much larger queue, or
+   * unbounded buffering, for only one of them can increase end-to-end latency
+   * for that stream and cause audio/video drift.
+   *
    * @generated from field: optional uint32 queue_size_frames = 8;
    */
   queueSizeFrames?: number;
@@ -284,6 +289,11 @@ export declare class AudioStreamFromParticipantRequest extends Message<AudioStre
    * default bounded queue size of 10 frames. Set it to 0 to request unbounded
    * buffering.
    *
+   * If your application consumes both audio and video, keep the queue sizing
+   * strategy coordinated across both streams. Using a much larger queue, or
+   * unbounded buffering, for only one of them can increase end-to-end latency
+   * for that stream and cause audio/video drift.
+   *
    * @generated from field: optional uint32 queue_size_frames = 10;
    */
   queueSizeFrames?: number;

livekit-ffi-node-bindings/proto/ffi_pb.d.ts

@@ -27,6 +27,7 @@ import type { E2eeRequest, E2eeResponse } from "./e2ee_pb.js";
 import type { PerformRpcCallback, PerformRpcRequest, PerformRpcResponse, RegisterRpcMethodRequest, RegisterRpcMethodResponse, RpcMethodInvocationEvent, RpcMethodInvocationResponseRequest, RpcMethodInvocationResponseResponse, UnregisterRpcMethodRequest, UnregisterRpcMethodResponse } from "./rpc_pb.js";
 import type { EnableRemoteTrackPublicationRequest, EnableRemoteTrackPublicationResponse, SetRemoteTrackPublicationQualityRequest, SetRemoteTrackPublicationQualityResponse, UpdateRemoteTrackPublicationDimensionRequest, UpdateRemoteTrackPublicationDimensionResponse } from "./track_publication_pb.js";
 import type { ByteStreamOpenCallback, ByteStreamOpenRequest, ByteStreamOpenResponse, ByteStreamReaderEvent, ByteStreamReaderReadAllCallback, ByteStreamReaderReadAllRequest, ByteStreamReaderReadAllResponse, ByteStreamReaderReadIncrementalRequest, ByteStreamReaderReadIncrementalResponse, ByteStreamReaderWriteToFileCallback, ByteStreamReaderWriteToFileRequest, ByteStreamReaderWriteToFileResponse, ByteStreamWriterCloseCallback, ByteStreamWriterCloseRequest, ByteStreamWriterCloseResponse, ByteStreamWriterWriteCallback, ByteStreamWriterWriteRequest, ByteStreamWriterWriteResponse, StreamSendBytesCallback, StreamSendBytesRequest, StreamSendBytesResponse, StreamSendFileCallback, StreamSendFileRequest, StreamSendFileResponse, StreamSendTextCallback, StreamSendTextRequest, StreamSendTextResponse, TextStreamOpenCallback, TextStreamOpenRequest, TextStreamOpenResponse, TextStreamReaderEvent, TextStreamReaderReadAllCallback, TextStreamReaderReadAllRequest, TextStreamReaderReadAllResponse, TextStreamReaderReadIncrementalRequest, TextStreamReaderReadIncrementalResponse, TextStreamWriterCloseCallback, TextStreamWriterCloseRequest, TextStreamWriterCloseResponse, TextStreamWriterWriteCallback, TextStreamWriterWriteRequest, TextStreamWriterWriteResponse } from "./data_stream_pb.js";
+import type { DataTrackStreamEvent, DataTrackStreamReadRequest, DataTrackStreamReadResponse, LocalDataTrackIsPublishedRequest, LocalDataTrackIsPublishedResponse, LocalDataTrackTryPushRequest, LocalDataTrackTryPushResponse, LocalDataTrackUnpublishRequest, LocalDataTrackUnpublishResponse, PublishDataTrackCallback, PublishDataTrackRequest, PublishDataTrackResponse, RemoteDataTrackIsPublishedRequest, RemoteDataTrackIsPublishedResponse, SubscribeDataTrackRequest, SubscribeDataTrackResponse } from "./data_track_pb.js";
 
 /**
  * @generated from enum livekit.proto.LogLevel
@@ -490,6 +491,52 @@ export declare class FfiRequest extends Message<FfiRequest> {
      */
     value: SetRemoteTrackPublicationQualityRequest;
     case: "setRemoteTrackPublicationQuality";
+  } | {
+    /**
+     * Data Track (local)
+     *
+     * @generated from field: livekit.proto.PublishDataTrackRequest publish_data_track = 69;
+     */
+    value: PublishDataTrackRequest;
+    case: "publishDataTrack";
+  } | {
+    /**
+     * @generated from field: livekit.proto.LocalDataTrackTryPushRequest local_data_track_try_push = 70;
+     */
+    value: LocalDataTrackTryPushRequest;
+    case: "localDataTrackTryPush";
+  } | {
+    /**
+     * @generated from field: livekit.proto.LocalDataTrackUnpublishRequest local_data_track_unpublish = 71;
+     */
+    value: LocalDataTrackUnpublishRequest;
+    case: "localDataTrackUnpublish";
+  } | {
+    /**
+     * @generated from field: livekit.proto.LocalDataTrackIsPublishedRequest local_data_track_is_published = 72;
+     */
+    value: LocalDataTrackIsPublishedRequest;
+    case: "localDataTrackIsPublished";
+  } | {
+    /**
+     * Data Track (remote)
+     *
+     * @generated from field: livekit.proto.SubscribeDataTrackRequest subscribe_data_track = 73;
+     */
+    value: SubscribeDataTrackRequest;
+    case: "subscribeDataTrack";
+  } | {
+    /**
+     * @generated from field: livekit.proto.RemoteDataTrackIsPublishedRequest remote_data_track_is_published = 74;
+     */
+    value: RemoteDataTrackIsPublishedRequest;
+    case: "remoteDataTrackIsPublished";
+  } | {
+    /**
+     * @generated from field: livekit.proto.DataTrackStreamReadRequest data_track_stream_read = 75;
+     */
+    value: DataTrackStreamReadRequest;
+    case: "dataTrackStreamRead";
   } | { case: undefined; value?: undefined };
 
   constructor(data?: PartialMessage<FfiRequest>);
@@ -932,6 +979,52 @@ export declare class FfiResponse extends Message<FfiResponse> {
      */
     value: SetRemoteTrackPublicationQualityResponse;
     case: "setRemoteTrackPublicationQuality";
+  } | {
+    /**
+     * Data Track (local)
+     *
+     * @generated from field: livekit.proto.PublishDataTrackResponse publish_data_track = 68;
+     */
+    value: PublishDataTrackResponse;
+    case: "publishDataTrack";
+  } | {
+    /**
+     * @generated from field: livekit.proto.LocalDataTrackTryPushResponse local_data_track_try_push = 69;
+     */
+    value: LocalDataTrackTryPushResponse;
+    case: "localDataTrackTryPush";
+  } | {
+    /**
+     * @generated from field: livekit.proto.LocalDataTrackUnpublishResponse local_data_track_unpublish = 70;
+     */
+    value: LocalDataTrackUnpublishResponse;
+    case: "localDataTrackUnpublish";
+  } | {
+    /**
+     * @generated from field: livekit.proto.LocalDataTrackIsPublishedResponse local_data_track_is_published = 71;
+     */
+    value: LocalDataTrackIsPublishedResponse;
+    case: "localDataTrackIsPublished";
+  } | {
+    /**
+     * Data Track (remote)
+     *
+     * @generated from field: livekit.proto.SubscribeDataTrackResponse subscribe_data_track = 72;
+     */
+    value: SubscribeDataTrackResponse;
+    case: "subscribeDataTrack";
+  } | {
+    /**
+     * @generated from field: livekit.proto.RemoteDataTrackIsPublishedResponse remote_data_track_is_published = 73;
+     */
+    value: RemoteDataTrackIsPublishedResponse;
+    case: "remoteDataTrackIsPublished";
+  } | {
+    /**
+     * @generated from field: livekit.proto.DataTrackStreamReadResponse data_track_stream_read = 74;
+     */
+    value: DataTrackStreamReadResponse;
+    case: "dataTrackStreamRead";
   } | { case: undefined; value?: undefined };
 
   constructor(data?: PartialMessage<FfiResponse>);
@@ -1204,6 +1297,22 @@ export declare class FfiEvent extends Message<FfiEvent> {
      */
     value: StreamSendBytesCallback;
     case: "sendBytes";
+  } | {
+    /**
+     * Data Track (local)
+     *
+     * @generated from field: livekit.proto.PublishDataTrackCallback publish_data_track = 42;
+     */
+    value: PublishDataTrackCallback;
+    case: "publishDataTrack";
+  } | {
+    /**
+     * Data Track (remote)
+     *
+     * @generated from field: livekit.proto.DataTrackStreamEvent data_track_stream_event = 43;
+     */
+    value: DataTrackStreamEvent;
+    case: "dataTrackStreamEvent";
   } | { case: undefined; value?: undefined };
 
   constructor(data?: PartialMessage<FfiEvent>);

livekit-ffi-node-bindings/proto/ffi_pb.js

@@ -29,6 +29,7 @@ const { E2eeRequest, E2eeResponse } = require("./e2ee_pb.js");
 const { PerformRpcCallback, PerformRpcRequest, PerformRpcResponse, RegisterRpcMethodRequest, RegisterRpcMethodResponse, RpcMethodInvocationEvent, RpcMethodInvocationResponseRequest, RpcMethodInvocationResponseResponse, UnregisterRpcMethodRequest, UnregisterRpcMethodResponse } = require("./rpc_pb.js");
 const { EnableRemoteTrackPublicationRequest, EnableRemoteTrackPublicationResponse, SetRemoteTrackPublicationQualityRequest, SetRemoteTrackPublicationQualityResponse, UpdateRemoteTrackPublicationDimensionRequest, UpdateRemoteTrackPublicationDimensionResponse } = require("./track_publication_pb.js");
 const { ByteStreamOpenCallback, ByteStreamOpenRequest, ByteStreamOpenResponse, ByteStreamReaderEvent, ByteStreamReaderReadAllCallback, ByteStreamReaderReadAllRequest, ByteStreamReaderReadAllResponse, ByteStreamReaderReadIncrementalRequest, ByteStreamReaderReadIncrementalResponse, ByteStreamReaderWriteToFileCallback, ByteStreamReaderWriteToFileRequest, ByteStreamReaderWriteToFileResponse, ByteStreamWriterCloseCallback, ByteStreamWriterCloseRequest, ByteStreamWriterCloseResponse, ByteStreamWriterWriteCallback, ByteStreamWriterWriteRequest, ByteStreamWriterWriteResponse, StreamSendBytesCallback, StreamSendBytesRequest, StreamSendBytesResponse, StreamSendFileCallback, StreamSendFileRequest, StreamSendFileResponse, StreamSendTextCallback, StreamSendTextRequest, StreamSendTextResponse, TextStreamOpenCallback, TextStreamOpenRequest, TextStreamOpenResponse, TextStreamReaderEvent, TextStreamReaderReadAllCallback, TextStreamReaderReadAllRequest, TextStreamReaderReadAllResponse, TextStreamReaderReadIncrementalRequest, TextStreamReaderReadIncrementalResponse, TextStreamWriterCloseCallback, TextStreamWriterCloseRequest, TextStreamWriterCloseResponse, TextStreamWriterWriteCallback, TextStreamWriterWriteRequest, TextStreamWriterWriteResponse } = require("./data_stream_pb.js");
+const { DataTrackStreamEvent, DataTrackStreamReadRequest, DataTrackStreamReadResponse, LocalDataTrackIsPublishedRequest, LocalDataTrackIsPublishedResponse, LocalDataTrackTryPushRequest, LocalDataTrackTryPushResponse, LocalDataTrackUnpublishRequest, LocalDataTrackUnpublishResponse, PublishDataTrackCallback, PublishDataTrackRequest, PublishDataTrackResponse, RemoteDataTrackIsPublishedRequest, RemoteDataTrackIsPublishedResponse, SubscribeDataTrackRequest, SubscribeDataTrackResponse } = require("./data_track_pb.js");
 
 /**
  * @generated from enum livekit.proto.LogLevel
@@ -120,6 +121,13 @@ const FfiRequest = /*@__PURE__*/ proto2.makeMessageType(
     { no: 66, name: "text_stream_close", kind: "message", T: TextStreamWriterCloseRequest, oneof: "message" },
     { no: 67, name: "send_bytes", kind: "message", T: StreamSendBytesRequest, oneof: "message" },
     { no: 68, name: "set_remote_track_publication_quality", kind: "message", T: SetRemoteTrackPublicationQualityRequest, oneof: "message" },
+    { no: 69, name: "publish_data_track", kind: "message", T: PublishDataTrackRequest, oneof: "message" },
+    { no: 70, name: "local_data_track_try_push", kind: "message", T: LocalDataTrackTryPushRequest, oneof: "message" },
+    { no: 71, name: "local_data_track_unpublish", kind: "message", T: LocalDataTrackUnpublishRequest, oneof: "message" },
+    { no: 72, name: "local_data_track_is_published", kind: "message", T: LocalDataTrackIsPublishedRequest, oneof: "message" },
+    { no: 73, name: "subscribe_data_track", kind: "message", T: SubscribeDataTrackRequest, oneof: "message" },
+    { no: 74, name: "remote_data_track_is_published", kind: "message", T: RemoteDataTrackIsPublishedRequest, oneof: "message" },
+    { no: 75, name: "data_track_stream_read", kind: "message", T: DataTrackStreamReadRequest, oneof: "message" },
   ],
 );
 
@@ -197,6 +205,13 @@ const FfiResponse = /*@__PURE__*/ proto2.makeMessageType(
     { no: 65, name: "text_stream_close", kind: "message", T: TextStreamWriterCloseResponse, oneof: "message" },
     { no: 66, name: "send_bytes", kind: "message", T: StreamSendBytesResponse, oneof: "message" },
     { no: 67, name: "set_remote_track_publication_quality", kind: "message", T: SetRemoteTrackPublicationQualityResponse, oneof: "message" },
+    { no: 68, name: "publish_data_track", kind: "message", T: PublishDataTrackResponse, oneof: "message" },
+    { no: 69, name: "local_data_track_try_push", kind: "message", T: LocalDataTrackTryPushResponse, oneof: "message" },
+    { no: 70, name: "local_data_track_unpublish", kind: "message", T: LocalDataTrackUnpublishResponse, oneof: "message" },
+    { no: 71, name: "local_data_track_is_published", kind: "message", T: LocalDataTrackIsPublishedResponse, oneof: "message" },
+    { no: 72, name: "subscribe_data_track", kind: "message", T: SubscribeDataTrackResponse, oneof: "message" },
+    { no: 73, name: "remote_data_track_is_published", kind: "message", T: RemoteDataTrackIsPublishedResponse, oneof: "message" },
+    { no: 74, name: "data_track_stream_read", kind: "message", T: DataTrackStreamReadResponse, oneof: "message" },
   ],
 );
 
@@ -250,6 +265,8 @@ const FfiEvent = /*@__PURE__*/ proto2.makeMessageType(
     { no: 39, name: "text_stream_writer_close", kind: "message", T: TextStreamWriterCloseCallback, oneof: "message" },
     { no: 40, name: "send_text", kind: "message", T: StreamSendTextCallback, oneof: "message" },
     { no: 41, name: "send_bytes", kind: "message", T: StreamSendBytesCallback, oneof: "message" },
+    { no: 42, name: "publish_data_track", kind: "message", T: PublishDataTrackCallback, oneof: "message" },
+    { no: 43, name: "data_track_stream_event", kind: "message", T: DataTrackStreamEvent, oneof: "message" },
   ],
 );
 

livekit-ffi-node-bindings/proto/room_pb.d.ts

@@ -26,6 +26,7 @@ import type { VideoCodec } from "./video_frame_pb.js";
 import type { E2eeOptions, EncryptionState } from "./e2ee_pb.js";
 import type { FfiOwnedHandle } from "./handle_pb.js";
 import type { OwnedByteStreamReader, OwnedTextStreamReader } from "./data_stream_pb.js";
+import type { OwnedRemoteDataTrack } from "./data_track_pb.js";
 
 /**
  * @generated from enum livekit.proto.IceTransportType
@@ -2157,6 +2158,18 @@ export declare class RoomEvent extends Message<RoomEvent> {
      */
     value: ParticipantActive;
     case: "participantActive";
+  } | {
+    /**
+     * @generated from field: livekit.proto.DataTrackPublished data_track_published = 43;
+     */
+    value: DataTrackPublished;
+    case: "dataTrackPublished";
+  } | {
+    /**
+     * @generated from field: livekit.proto.DataTrackUnpublished data_track_unpublished = 44;
+     */
+    value: DataTrackUnpublished;
+    case: "dataTrackUnpublished";
   } | { case: undefined; value?: undefined };
 
   constructor(data?: PartialMessage<RoomEvent>);
@@ -4133,3 +4146,57 @@ export declare class TextStreamOpened extends Message<TextStreamOpened> {
   static equals(a: TextStreamOpened | PlainMessage<TextStreamOpened> | undefined, b: TextStreamOpened | PlainMessage<TextStreamOpened> | undefined): boolean;
 }
 
+/**
+ * A remote participant published a data track.
+ *
+ * @generated from message livekit.proto.DataTrackPublished
+ */
+export declare class DataTrackPublished extends Message<DataTrackPublished> {
+  /**
+   * @generated from field: required livekit.proto.OwnedRemoteDataTrack track = 1;
+   */
+  track?: OwnedRemoteDataTrack;
+
+  constructor(data?: PartialMessage<DataTrackPublished>);
+
+  static readonly runtime: typeof proto2;
+  static readonly typeName = "livekit.proto.DataTrackPublished";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): DataTrackPublished;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): DataTrackPublished;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): DataTrackPublished;
+
+  static equals(a: DataTrackPublished | PlainMessage<DataTrackPublished> | undefined, b: DataTrackPublished | PlainMessage<DataTrackPublished> | undefined): boolean;
+}
+
+/**
+ * A remote participant unpublished a data track.
+ *
+ * @generated from message livekit.proto.DataTrackUnpublished
+ */
+export declare class DataTrackUnpublished extends Message<DataTrackUnpublished> {
+  /**
+   * SID of the track that was unpublished.
+   *
+   * @generated from field: required string sid = 1;
+   */
+  sid?: string;
+
+  constructor(data?: PartialMessage<DataTrackUnpublished>);
+
+  static readonly runtime: typeof proto2;
+  static readonly typeName = "livekit.proto.DataTrackUnpublished";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): DataTrackUnpublished;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): DataTrackUnpublished;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): DataTrackUnpublished;
+
+  static equals(a: DataTrackUnpublished | PlainMessage<DataTrackUnpublished> | undefined, b: DataTrackUnpublished | PlainMessage<DataTrackUnpublished> | undefined): boolean;
+}
+

livekit-ffi-node-bindings/proto/room_pb.js

@@ -28,6 +28,7 @@ const { VideoCodec } = require("./video_frame_pb.js");
 const { E2eeOptions, EncryptionState } = require("./e2ee_pb.js");
 const { FfiOwnedHandle } = require("./handle_pb.js");
 const { OwnedByteStreamReader, OwnedTextStreamReader } = require("./data_stream_pb.js");
+const { OwnedRemoteDataTrack } = require("./data_track_pb.js");
 
 /**
  * @generated from enum livekit.proto.IceTransportType
@@ -770,6 +771,8 @@ const RoomEvent = /*@__PURE__*/ proto2.makeMessageType(
     { no: 41, name: "participant_permission_changed", kind: "message", T: ParticipantPermissionChanged, oneof: "message" },
     { no: 40, name: "token_refreshed", kind: "message", T: TokenRefreshed, oneof: "message" },
     { no: 42, name: "participant_active", kind: "message", T: ParticipantActive, oneof: "message" },
+    { no: 43, name: "data_track_published", kind: "message", T: DataTrackPublished, oneof: "message" },
+    { no: 44, name: "data_track_unpublished", kind: "message", T: DataTrackUnpublished, oneof: "message" },
   ],
 );
 
@@ -1492,6 +1495,30 @@ const TextStreamOpened = /*@__PURE__*/ proto2.makeMessageType(
   ],
 );
 
+/**
+ * A remote participant published a data track.
+ *
+ * @generated from message livekit.proto.DataTrackPublished
+ */
+const DataTrackPublished = /*@__PURE__*/ proto2.makeMessageType(
+  "livekit.proto.DataTrackPublished",
+  () => [
+    { no: 1, name: "track", kind: "message", T: OwnedRemoteDataTrack, req: true },
+  ],
+);
+
+/**
+ * A remote participant unpublished a data track.
+ *
+ * @generated from message livekit.proto.DataTrackUnpublished
+ */
+const DataTrackUnpublished = /*@__PURE__*/ proto2.makeMessageType(
+  "livekit.proto.DataTrackUnpublished",
+  () => [
+    { no: 1, name: "sid", kind: "scalar", T: 9 /* ScalarType.STRING */, req: true },
+  ],
+);
+
 
 exports.IceTransportType = IceTransportType;
 exports.ContinualGatheringPolicy = ContinualGatheringPolicy;
@@ -1614,3 +1641,5 @@ exports.SetDataChannelBufferedAmountLowThresholdResponse = SetDataChannelBuffere
 exports.DataChannelBufferedAmountLowThresholdChanged = DataChannelBufferedAmountLowThresholdChanged;
 exports.ByteStreamOpened = ByteStreamOpened;
 exports.TextStreamOpened = TextStreamOpened;
+exports.DataTrackPublished = DataTrackPublished;
+exports.DataTrackUnpublished = DataTrackUnpublished;