Expose a dtmf function for Video RoomSession object (#909)

* Expose the function for Video RoomSession object * function renamed to sendDigits
signalwire · Nov 16, 2023 · 4ee7b6f · 4ee7b6f
1 parent d564c37
commit 4ee7b6f
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 3 deletions.
diff --git a/.changeset/fuzzy-flowers-joke.md b/.changeset/fuzzy-flowers-joke.md
@@ -0,0 +1,6 @@
+---
+'@signalwire/webrtc': minor
+'@signalwire/core': minor
+---
+
+Expose the `sendDigits` function for Video RoomSession object
diff --git a/packages/core/src/types/index.ts b/packages/core/src/types/index.ts
@@ -133,6 +133,17 @@ export interface BaseConnectionContract<
  */
  setLocalStream(stream: MediaStream): Promise<MediaStream>
 
+ /**
+ * Send DTMF
+ * @param {string} dtmf
+ *
+ * @example
+ * ```typescript
+ * room.sendDigits('1')
+ * ```
+ */
+ sendDigits(dtmf: string): Promise<void>
+
  /** @internal */
  stopOutboundAudio(): void
  /** @internal */

diff --git a/packages/webrtc/src/BaseConnection.ts b/packages/webrtc/src/BaseConnection.ts
@@ -909,14 +909,17 @@ export class BaseConnection<EventTypes extends EventEmitter.ValidEventTypes>
  }
  }
 
- /** @internal */
- dtmf(dtmf: string) {
+ async sendDigits(dtmf: string) {
  const rtcPeerId = this.callId
  if (!rtcPeerId) {
  throw new Error('Invalid RTCPeer ID to send DTMF')
  }
  const message = VertoInfo({ ...this.dialogParams(rtcPeerId), dtmf })
- this.vertoExecute({ message, callID: rtcPeerId, node_id: this.nodeId })
+ await this.vertoExecute({
+ message,
+ callID: rtcPeerId,
+ node_id: this.nodeId,
+ })
  }
 
  /** @internal */