Update rust sdk, add dtmf and attributes support (#239)

* Update rust sdk and add dtmf support * update rust-sdks pointer to main * add enableQueue for AudioSource constructor * add attributes support * Add support for retrieving attributes * reuse * add changesets
livekit · Jul 18, 2024 · 3b40e58 · 3b40e58
1 parent a23c543
commit 3b40e58
Show file tree

Hide file tree

Showing 19 changed files with 1,187 additions and 322 deletions.
diff --git a/.changeset/cold-parents-visit.md b/.changeset/cold-parents-visit.md
@@ -0,0 +1,5 @@
+---
+'@livekit/rtc-node': minor
+---
+
+Update rust-sdk dependency to latest
diff --git a/.changeset/dry-lizards-tan.md b/.changeset/dry-lizards-tan.md
@@ -0,0 +1,5 @@
+---
+'@livekit/rtc-node': patch
+---
+
+Add publishDtmf method on local participant
diff --git a/.changeset/kind-cups-obey.md b/.changeset/kind-cups-obey.md
@@ -0,0 +1,5 @@
+---
+'@livekit/rtc-node': patch
+---
+
+Add support for setting and listening to participant attribute changes
diff --git a/.changeset/neat-falcons-type.md b/.changeset/neat-falcons-type.md
@@ -0,0 +1,5 @@
+---
+'@livekit/rtc-node': patch
+---
+
+Add enableQueue argument to AudioSource constructor
diff --git a/.gitignore b/.gitignore
@@ -72,6 +72,9 @@ web_modules/
 # Yarn Integrity file
 .yarn-integrity
 
+# macOS
+.DS_Store
+
 # dotenv environment variable files
 .env
 .env.development.local

diff --git a/packages/livekit-rtc/rust-sdks b/packages/livekit-rtc/rust-sdks
diff --git a/packages/livekit-rtc/src/audio_source.ts b/packages/livekit-rtc/src/audio_source.ts
@@ -25,14 +25,15 @@ export class AudioSource {
   sampleRate: number;
   numChannels: number;
 
-  constructor(sampleRate: number, numChannels: number) {
+  constructor(sampleRate: number, numChannels: number, enableQueue?: boolean) {
     this.sampleRate = sampleRate;
     this.numChannels = numChannels;
 
     const req = new NewAudioSourceRequest({
       type: AudioSourceType.AUDIO_SOURCE_NATIVE,
       sampleRate: sampleRate,
       numChannels: numChannels,
+      enableQueue: enableQueue,
     });
 
     const res = FfiClient.instance.request<NewAudioSourceResponse>({

diff --git a/packages/livekit-rtc/src/participant.ts b/packages/livekit-rtc/src/participant.ts
@@ -6,23 +6,28 @@ import type { OwnedParticipant, ParticipantInfo } from './proto/participant_pb.j
 import type {
   PublishDataCallback,
   PublishDataResponse,
+  PublishSipDtmfCallback,
+  PublishSipDtmfResponse,
   PublishTrackCallback,
   PublishTrackResponse,
+  SetLocalAttributesCallback,
+  SetLocalAttributesResponse,
+  SetLocalMetadataCallback,
+  SetLocalMetadataResponse,
+  SetLocalNameCallback,
+  SetLocalNameResponse,
   TrackPublishOptions,
   UnpublishTrackCallback,
   UnpublishTrackResponse,
-  UpdateLocalMetadataCallback,
-  UpdateLocalMetadataResponse,
-  UpdateLocalNameCallback,
-  UpdateLocalNameResponse,
 } from './proto/room_pb.js';
 import {
-  DataPacketKind,
   PublishDataRequest,
+  PublishSipDtmfRequest,
   PublishTrackRequest,
+  SetLocalAttributesRequest,
+  SetLocalMetadataRequest,
+  SetLocalNameRequest,
   UnpublishTrackRequest,
-  UpdateLocalMetadataRequest,
-  UpdateLocalNameRequest,
 } from './proto/room_pb.js';
 import type { LocalTrack } from './track.js';
 import type { RemoteTrackPublication, TrackPublication } from './track_publication.js';
@@ -57,6 +62,10 @@ export abstract class Participant {
   get metadata(): string {
     return this.info.metadata;
   }
+
+  get attributes(): Record<string, string> {
+    return this.info.attributes;
+  }
 }
 
 export type DataPublishOptions = {
@@ -68,9 +77,9 @@ export type DataPublishOptions = {
    */
   reliable?: boolean;
   /**
-   * the sids of participants who will receive the message, will be sent to every one if empty
+   * the identities of participants who will receive the message, will be sent to every one if empty
    */
-  destination?: string[] | RemoteParticipant[];
+  destination_identities?: string[];
   /** the topic under which the message gets published */
   topic?: string;
 };
@@ -83,18 +92,11 @@ export class LocalParticipant extends Participant {
       localParticipantHandle: this.ffi_handle.handle,
       dataPtr: FfiClient.instance.retrievePtr(data),
       dataLen: BigInt(data.byteLength),
-      kind: options.reliable ? DataPacketKind.KIND_RELIABLE : DataPacketKind.KIND_LOSSY,
+      reliable: options.reliable,
       topic: options.topic,
+      destinationIdentities: options.destination_identities,
     });
 
-    if (options.destination) {
-      const sids = options.destination.map((sid: string | RemoteParticipant) => {
-        if (typeof sid == 'string') return sid;
-        return sid.sid;
-      });
-      req.destinationSids = sids;
-    }
-
     const res = FfiClient.instance.request<PublishDataResponse>({
       message: { case: 'publishData', value: req },
     });
@@ -108,33 +110,67 @@ export class LocalParticipant extends Participant {
     }
   }
 
+  async publishDtmf(code: number, digit: string) {
+    const req = new PublishSipDtmfRequest({
+      code,
+      digit,
+    });
+
+    const res = FfiClient.instance.request<PublishSipDtmfResponse>({
+      message: { case: 'publishSipDtmf', value: req },
+    });
+
+    const cb = await FfiClient.instance.waitFor<PublishSipDtmfCallback>((ev) => {
+      return ev.message.case == 'publishSipDtmf' && ev.message.value.asyncId == res.asyncId;
+    });
+
+    if (cb.error) {
+      throw new Error(cb.error);
+    }
+  }
+
   async updateMetadata(metadata: string) {
-    const req = new UpdateLocalMetadataRequest({
+    const req = new SetLocalMetadataRequest({
       localParticipantHandle: this.ffi_handle.handle,
       metadata: metadata,
     });
 
-    const res = FfiClient.instance.request<UpdateLocalMetadataResponse>({
-      message: { case: 'updateLocalMetadata', value: req },
+    const res = FfiClient.instance.request<SetLocalMetadataResponse>({
+      message: { case: 'setLocalMetadata', value: req },
     });
 
-    await FfiClient.instance.waitFor<UpdateLocalMetadataCallback>((ev) => {
-      return ev.message.case == 'updateLocalMetadata' && ev.message.value.asyncId == res.asyncId;
+    await FfiClient.instance.waitFor<SetLocalMetadataCallback>((ev) => {
+      return ev.message.case == 'setLocalMetadata' && ev.message.value.asyncId == res.asyncId;
     });
   }
 
   async updateName(name: string) {
-    const req = new UpdateLocalNameRequest({
+    const req = new SetLocalNameRequest({
       localParticipantHandle: this.ffi_handle.handle,
       name: name,
     });
 
-    const res = FfiClient.instance.request<UpdateLocalNameResponse>({
-      message: { case: 'updateLocalName', value: req },
+    const res = FfiClient.instance.request<SetLocalNameResponse>({
+      message: { case: 'setLocalName', value: req },
+    });
+
+    await FfiClient.instance.waitFor<SetLocalNameCallback>((ev) => {
+      return ev.message.case == 'setLocalName' && ev.message.value.asyncId == res.asyncId;
+    });
+  }
+
+  async setAttributes(attributes: Record<string, string>) {
+    const req = new SetLocalAttributesRequest({
+      localParticipantHandle: this.ffi_handle.handle,
+      attributes: attributes,
+    });
+
+    const res = FfiClient.instance.request<SetLocalAttributesResponse>({
+      message: { case: 'setLocalAttributes', value: req },
     });
 
-    await FfiClient.instance.waitFor<UpdateLocalNameCallback>((ev) => {
-      return ev.message.case == 'updateLocalName' && ev.message.value.asyncId == res.asyncId;
+    await FfiClient.instance.waitFor<SetLocalAttributesCallback>((ev) => {
+      return ev.message.case == 'setLocalAttributes' && ev.message.value.asyncId == res.asyncId;
     });
   }
 

diff --git a/packages/livekit-rtc/src/proto/audio_frame_pb.ts b/packages/livekit-rtc/src/proto/audio_frame_pb.ts
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// @generated by protoc-gen-es v1.7.2 with parameter "target=ts"
+// @generated by protoc-gen-es v1.10.0 with parameter "target=ts"
 // @generated from file audio_frame.proto (package livekit.proto, syntax proto3)
 /* eslint-disable */
 // @ts-nocheck
@@ -164,6 +164,11 @@ export class NewAudioSourceRequest extends Message<NewAudioSourceRequest> {
    */
   numChannels = 0;
 
+  /**
+   * @generated from field: optional bool enable_queue = 5;
+   */
+  enableQueue?: boolean;
+
   constructor(data?: PartialMessage<NewAudioSourceRequest>) {
     super();
     proto3.util.initPartial(data, this);
@@ -176,6 +181,7 @@ export class NewAudioSourceRequest extends Message<NewAudioSourceRequest> {
     { no: 2, name: "options", kind: "message", T: AudioSourceOptions, opt: true },
     { no: 3, name: "sample_rate", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
     { no: 4, name: "num_channels", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
+    { no: 5, name: "enable_queue", kind: "scalar", T: 8 /* ScalarType.BOOL */, opt: true },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): NewAudioSourceRequest {

diff --git a/packages/livekit-rtc/src/proto/e2ee_pb.ts b/packages/livekit-rtc/src/proto/e2ee_pb.ts
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// @generated by protoc-gen-es v1.7.2 with parameter "target=ts"
+// @generated by protoc-gen-es v1.10.0 with parameter "target=ts"
 // @generated from file e2ee.proto (package livekit.proto, syntax proto3)
 /* eslint-disable */
 // @ts-nocheck