assemblyai 4.36.3 → 4.36.4

package/dist/deno.mjs

@@ -37,7 +37,7 @@ if (typeof navigator !== "undefined" && navigator.userAgent) {
     defaultUserAgentString += navigator.userAgent;
 }
 const defaultUserAgent = {
-    sdk: { name: "JavaScript", version: "4.36.3" },
+    sdk: { name: "JavaScript", version: "4.36.4" },
 };
 if (typeof process !== "undefined") {
     if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
@@ -1368,9 +1368,12 @@ class StreamingTranscriber {
         if (!(this.token || this.apiKey)) {
             throw new Error("API key or temporary token is required.");
         }
-        const isOpus = params.encoding === "opus" || params.encoding === "ogg_opus";
-        if (params.sampleRate === undefined && (!isOpus || params.channels)) {
-            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus" or "ogg_opus" (the Opus stream is self-describing) and dual-channel mode is not used.');
+        const isSelfDescribing = params.encoding === "opus" ||
+            params.encoding === "ogg_opus" ||
+            params.encoding === "aac";
+        if (params.sampleRate === undefined &&
+            (!isSelfDescribing || params.channels)) {
+            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus", "ogg_opus", or "aac" (these streams are self-describing) and dual-channel mode is not used.');
         }
         if (params.channels) {
             if (params.channels.length !== 2) {
@@ -1448,6 +1451,9 @@ class StreamingTranscriber {
         if (this.params.formatTurns) {
             searchParams.set("format_turns", this.params.formatTurns.toString());
         }
+        if (this.params.sessionHeartbeat !== undefined) {
+            searchParams.set("session_heartbeat", this.params.sessionHeartbeat.toString());
+        }
         if (this.params.encoding) {
             searchParams.set("encoding", this.params.encoding.toString());
         }
@@ -1732,6 +1738,10 @@ class StreamingTranscriber {
                         this.listeners.warning?.(warning);
                         break;
                     }
+                    case "Heartbeat": {
+                        this.listeners.heartbeat?.(message);
+                        break;
+                    }
                     case "Termination": {
                         this.sessionTerminatedResolve?.();
                         break;

package/dist/index.cjs

@@ -109,7 +109,7 @@ if (typeof navigator !== "undefined" && navigator.userAgent) {
     defaultUserAgentString += navigator.userAgent;
 }
 const defaultUserAgent = {
-    sdk: { name: "JavaScript", version: "4.36.3" },
+    sdk: { name: "JavaScript", version: "4.36.4" },
 };
 if (typeof process !== "undefined") {
     if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
@@ -1514,9 +1514,12 @@ class StreamingTranscriber {
         if (!(this.token || this.apiKey)) {
             throw new Error("API key or temporary token is required.");
         }
-        const isOpus = params.encoding === "opus" || params.encoding === "ogg_opus";
-        if (params.sampleRate === undefined && (!isOpus || params.channels)) {
-            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus" or "ogg_opus" (the Opus stream is self-describing) and dual-channel mode is not used.');
+        const isSelfDescribing = params.encoding === "opus" ||
+            params.encoding === "ogg_opus" ||
+            params.encoding === "aac";
+        if (params.sampleRate === undefined &&
+            (!isSelfDescribing || params.channels)) {
+            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus", "ogg_opus", or "aac" (these streams are self-describing) and dual-channel mode is not used.');
         }
         if (params.channels) {
             if (params.channels.length !== 2) {
@@ -1594,6 +1597,9 @@ class StreamingTranscriber {
         if (this.params.formatTurns) {
             searchParams.set("format_turns", this.params.formatTurns.toString());
         }
+        if (this.params.sessionHeartbeat !== undefined) {
+            searchParams.set("session_heartbeat", this.params.sessionHeartbeat.toString());
+        }
         if (this.params.encoding) {
             searchParams.set("encoding", this.params.encoding.toString());
         }
@@ -1825,7 +1831,7 @@ class StreamingTranscriber {
                 (_c = (_b = this.listeners).error) === null || _c === void 0 ? void 0 : _c.call(_b, error);
             };
             this.socket.onmessage = ({ data }) => {
-                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
                 const message = JSON.parse(data.toString());
                 if ("error" in message) {
                     const err = new StreamingError(message.error);
@@ -1885,8 +1891,12 @@ class StreamingTranscriber {
                         (_p = (_o = this.listeners).warning) === null || _p === void 0 ? void 0 : _p.call(_o, warning);
                         break;
                     }
+                    case "Heartbeat": {
+                        (_r = (_q = this.listeners).heartbeat) === null || _r === void 0 ? void 0 : _r.call(_q, message);
+                        break;
+                    }
                     case "Termination": {
-                        (_q = this.sessionTerminatedResolve) === null || _q === void 0 ? void 0 : _q.call(this);
+                        (_s = this.sessionTerminatedResolve) === null || _s === void 0 ? void 0 : _s.call(this);
                         break;
                     }
                 }

package/dist/index.mjs

@@ -107,7 +107,7 @@ if (typeof navigator !== "undefined" && navigator.userAgent) {
     defaultUserAgentString += navigator.userAgent;
 }
 const defaultUserAgent = {
-    sdk: { name: "JavaScript", version: "4.36.3" },
+    sdk: { name: "JavaScript", version: "4.36.4" },
 };
 if (typeof process !== "undefined") {
     if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
@@ -1512,9 +1512,12 @@ class StreamingTranscriber {
         if (!(this.token || this.apiKey)) {
             throw new Error("API key or temporary token is required.");
         }
-        const isOpus = params.encoding === "opus" || params.encoding === "ogg_opus";
-        if (params.sampleRate === undefined && (!isOpus || params.channels)) {
-            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus" or "ogg_opus" (the Opus stream is self-describing) and dual-channel mode is not used.');
+        const isSelfDescribing = params.encoding === "opus" ||
+            params.encoding === "ogg_opus" ||
+            params.encoding === "aac";
+        if (params.sampleRate === undefined &&
+            (!isSelfDescribing || params.channels)) {
+            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus", "ogg_opus", or "aac" (these streams are self-describing) and dual-channel mode is not used.');
         }
         if (params.channels) {
             if (params.channels.length !== 2) {
@@ -1592,6 +1595,9 @@ class StreamingTranscriber {
         if (this.params.formatTurns) {
             searchParams.set("format_turns", this.params.formatTurns.toString());
         }
+        if (this.params.sessionHeartbeat !== undefined) {
+            searchParams.set("session_heartbeat", this.params.sessionHeartbeat.toString());
+        }
         if (this.params.encoding) {
             searchParams.set("encoding", this.params.encoding.toString());
         }
@@ -1823,7 +1829,7 @@ class StreamingTranscriber {
                 (_c = (_b = this.listeners).error) === null || _c === void 0 ? void 0 : _c.call(_b, error);
             };
             this.socket.onmessage = ({ data }) => {
-                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
                 const message = JSON.parse(data.toString());
                 if ("error" in message) {
                     const err = new StreamingError(message.error);
@@ -1883,8 +1889,12 @@ class StreamingTranscriber {
                         (_p = (_o = this.listeners).warning) === null || _p === void 0 ? void 0 : _p.call(_o, warning);
                         break;
                     }
+                    case "Heartbeat": {
+                        (_r = (_q = this.listeners).heartbeat) === null || _r === void 0 ? void 0 : _r.call(_q, message);
+                        break;
+                    }
                     case "Termination": {
-                        (_q = this.sessionTerminatedResolve) === null || _q === void 0 ? void 0 : _q.call(this);
+                        (_s = this.sessionTerminatedResolve) === null || _s === void 0 ? void 0 : _s.call(this);
                         break;
                     }
                 }

package/dist/node.cjs

@@ -42,7 +42,7 @@ if (typeof navigator !== "undefined" && navigator.userAgent) {
     defaultUserAgentString += navigator.userAgent;
 }
 const defaultUserAgent = {
-    sdk: { name: "JavaScript", version: "4.36.3" },
+    sdk: { name: "JavaScript", version: "4.36.4" },
 };
 if (typeof process !== "undefined") {
     if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
@@ -1367,9 +1367,12 @@ class StreamingTranscriber {
         if (!(this.token || this.apiKey)) {
             throw new Error("API key or temporary token is required.");
         }
-        const isOpus = params.encoding === "opus" || params.encoding === "ogg_opus";
-        if (params.sampleRate === undefined && (!isOpus || params.channels)) {
-            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus" or "ogg_opus" (the Opus stream is self-describing) and dual-channel mode is not used.');
+        const isSelfDescribing = params.encoding === "opus" ||
+            params.encoding === "ogg_opus" ||
+            params.encoding === "aac";
+        if (params.sampleRate === undefined &&
+            (!isSelfDescribing || params.channels)) {
+            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus", "ogg_opus", or "aac" (these streams are self-describing) and dual-channel mode is not used.');
         }
         if (params.channels) {
             if (params.channels.length !== 2) {
@@ -1447,6 +1450,9 @@ class StreamingTranscriber {
         if (this.params.formatTurns) {
             searchParams.set("format_turns", this.params.formatTurns.toString());
         }
+        if (this.params.sessionHeartbeat !== undefined) {
+            searchParams.set("session_heartbeat", this.params.sessionHeartbeat.toString());
+        }
         if (this.params.encoding) {
             searchParams.set("encoding", this.params.encoding.toString());
         }
@@ -1731,6 +1737,10 @@ class StreamingTranscriber {
                         this.listeners.warning?.(warning);
                         break;
                     }
+                    case "Heartbeat": {
+                        this.listeners.heartbeat?.(message);
+                        break;
+                    }
                     case "Termination": {
                         this.sessionTerminatedResolve?.();
                         break;

package/dist/node.mjs

@@ -40,7 +40,7 @@ if (typeof navigator !== "undefined" && navigator.userAgent) {
     defaultUserAgentString += navigator.userAgent;
 }
 const defaultUserAgent = {
-    sdk: { name: "JavaScript", version: "4.36.3" },
+    sdk: { name: "JavaScript", version: "4.36.4" },
 };
 if (typeof process !== "undefined") {
     if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
@@ -1365,9 +1365,12 @@ class StreamingTranscriber {
         if (!(this.token || this.apiKey)) {
             throw new Error("API key or temporary token is required.");
         }
-        const isOpus = params.encoding === "opus" || params.encoding === "ogg_opus";
-        if (params.sampleRate === undefined && (!isOpus || params.channels)) {
-            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus" or "ogg_opus" (the Opus stream is self-describing) and dual-channel mode is not used.');
+        const isSelfDescribing = params.encoding === "opus" ||
+            params.encoding === "ogg_opus" ||
+            params.encoding === "aac";
+        if (params.sampleRate === undefined &&
+            (!isSelfDescribing || params.channels)) {
+            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus", "ogg_opus", or "aac" (these streams are self-describing) and dual-channel mode is not used.');
         }
         if (params.channels) {
             if (params.channels.length !== 2) {
@@ -1445,6 +1448,9 @@ class StreamingTranscriber {
         if (this.params.formatTurns) {
             searchParams.set("format_turns", this.params.formatTurns.toString());
         }
+        if (this.params.sessionHeartbeat !== undefined) {
+            searchParams.set("session_heartbeat", this.params.sessionHeartbeat.toString());
+        }
         if (this.params.encoding) {
             searchParams.set("encoding", this.params.encoding.toString());
         }
@@ -1729,6 +1735,10 @@ class StreamingTranscriber {
                         this.listeners.warning?.(warning);
                         break;
                     }
+                    case "Heartbeat": {
+                        this.listeners.heartbeat?.(message);
+                        break;
+                    }
                     case "Termination": {
                         this.sessionTerminatedResolve?.();
                         break;

package/dist/services/streaming/service.d.ts

@@ -1,4 +1,4 @@
-import { StreamingTranscriberParams, AudioData, BeginEvent, TurnEvent, LLMGatewayResponseEvent, SpeakerRevisionEvent, StreamingUpdateConfiguration, WarningEvent } from "../..";
+import { StreamingTranscriberParams, AudioData, BeginEvent, TurnEvent, LLMGatewayResponseEvent, SpeakerRevisionEvent, StreamingUpdateConfiguration, WarningEvent, HeartbeatEvent } from "../..";
 import type { VadFrame } from "../../types/streaming/dual-channel";
 /**
  * Options for `sendAudio`. In dual-channel mode (when `channels` is configured
@@ -36,6 +36,7 @@ export declare class StreamingTranscriber {
     on(event: "llmGatewayResponse", listener: (event: LLMGatewayResponseEvent) => void): void;
     on(event: "speakerRevision", listener: (event: SpeakerRevisionEvent) => void): void;
     on(event: "warning", listener: (event: WarningEvent) => void): void;
+    on(event: "heartbeat", listener: (event: HeartbeatEvent) => void): void;
     on(event: "vad", listener: (event: VadFrame) => void): void;
     on(event: "error", listener: (error: Error) => void): void;
     on(event: "close", listener: (code: number, reason: string) => void): void;

package/dist/streaming.browser.mjs

@@ -584,9 +584,12 @@ class StreamingTranscriber {
         if (!(this.token || this.apiKey)) {
             throw new Error("API key or temporary token is required.");
         }
-        const isOpus = params.encoding === "opus" || params.encoding === "ogg_opus";
-        if (params.sampleRate === undefined && (!isOpus || params.channels)) {
-            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus" or "ogg_opus" (the Opus stream is self-describing) and dual-channel mode is not used.');
+        const isSelfDescribing = params.encoding === "opus" ||
+            params.encoding === "ogg_opus" ||
+            params.encoding === "aac";
+        if (params.sampleRate === undefined &&
+            (!isSelfDescribing || params.channels)) {
+            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus", "ogg_opus", or "aac" (these streams are self-describing) and dual-channel mode is not used.');
         }
         if (params.channels) {
             if (params.channels.length !== 2) {
@@ -664,6 +667,9 @@ class StreamingTranscriber {
         if (this.params.formatTurns) {
             searchParams.set("format_turns", this.params.formatTurns.toString());
         }
+        if (this.params.sessionHeartbeat !== undefined) {
+            searchParams.set("session_heartbeat", this.params.sessionHeartbeat.toString());
+        }
         if (this.params.encoding) {
             searchParams.set("encoding", this.params.encoding.toString());
         }
@@ -952,6 +958,10 @@ Learn more at https://github.com/AssemblyAI/assemblyai-node-sdk/blob/main/docs/c
                         this.listeners.warning?.(warning);
                         break;
                     }
+                    case "Heartbeat": {
+                        this.listeners.heartbeat?.(message);
+                        break;
+                    }
                     case "Termination": {
                         this.sessionTerminatedResolve?.();
                         break;
@@ -1312,7 +1322,7 @@ if (typeof navigator !== "undefined" && navigator.userAgent) {
     defaultUserAgentString += navigator.userAgent;
 }
 const defaultUserAgent = {
-    sdk: { name: "JavaScript", version: "4.36.3" },
+    sdk: { name: "JavaScript", version: "4.36.4" },
 };
 if (typeof process !== "undefined") {
     if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {

package/dist/streaming.cjs

@@ -630,9 +630,12 @@ class StreamingTranscriber {
         if (!(this.token || this.apiKey)) {
             throw new Error("API key or temporary token is required.");
         }
-        const isOpus = params.encoding === "opus" || params.encoding === "ogg_opus";
-        if (params.sampleRate === undefined && (!isOpus || params.channels)) {
-            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus" or "ogg_opus" (the Opus stream is self-describing) and dual-channel mode is not used.');
+        const isSelfDescribing = params.encoding === "opus" ||
+            params.encoding === "ogg_opus" ||
+            params.encoding === "aac";
+        if (params.sampleRate === undefined &&
+            (!isSelfDescribing || params.channels)) {
+            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus", "ogg_opus", or "aac" (these streams are self-describing) and dual-channel mode is not used.');
         }
         if (params.channels) {
             if (params.channels.length !== 2) {
@@ -710,6 +713,9 @@ class StreamingTranscriber {
         if (this.params.formatTurns) {
             searchParams.set("format_turns", this.params.formatTurns.toString());
         }
+        if (this.params.sessionHeartbeat !== undefined) {
+            searchParams.set("session_heartbeat", this.params.sessionHeartbeat.toString());
+        }
         if (this.params.encoding) {
             searchParams.set("encoding", this.params.encoding.toString());
         }
@@ -941,7 +947,7 @@ class StreamingTranscriber {
                 (_c = (_b = this.listeners).error) === null || _c === void 0 ? void 0 : _c.call(_b, error);
             };
             this.socket.onmessage = ({ data }) => {
-                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
                 const message = JSON.parse(data.toString());
                 if ("error" in message) {
                     const err = new StreamingError(message.error);
@@ -1001,8 +1007,12 @@ class StreamingTranscriber {
                         (_p = (_o = this.listeners).warning) === null || _p === void 0 ? void 0 : _p.call(_o, warning);
                         break;
                     }
+                    case "Heartbeat": {
+                        (_r = (_q = this.listeners).heartbeat) === null || _r === void 0 ? void 0 : _r.call(_q, message);
+                        break;
+                    }
                     case "Termination": {
-                        (_q = this.sessionTerminatedResolve) === null || _q === void 0 ? void 0 : _q.call(this);
+                        (_s = this.sessionTerminatedResolve) === null || _s === void 0 ? void 0 : _s.call(this);
                         break;
                     }
                 }

package/dist/streaming.mjs

@@ -628,9 +628,12 @@ class StreamingTranscriber {
         if (!(this.token || this.apiKey)) {
             throw new Error("API key or temporary token is required.");
         }
-        const isOpus = params.encoding === "opus" || params.encoding === "ogg_opus";
-        if (params.sampleRate === undefined && (!isOpus || params.channels)) {
-            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus" or "ogg_opus" (the Opus stream is self-describing) and dual-channel mode is not used.');
+        const isSelfDescribing = params.encoding === "opus" ||
+            params.encoding === "ogg_opus" ||
+            params.encoding === "aac";
+        if (params.sampleRate === undefined &&
+            (!isSelfDescribing || params.channels)) {
+            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus", "ogg_opus", or "aac" (these streams are self-describing) and dual-channel mode is not used.');
         }
         if (params.channels) {
             if (params.channels.length !== 2) {
@@ -708,6 +711,9 @@ class StreamingTranscriber {
         if (this.params.formatTurns) {
             searchParams.set("format_turns", this.params.formatTurns.toString());
         }
+        if (this.params.sessionHeartbeat !== undefined) {
+            searchParams.set("session_heartbeat", this.params.sessionHeartbeat.toString());
+        }
         if (this.params.encoding) {
             searchParams.set("encoding", this.params.encoding.toString());
         }
@@ -939,7 +945,7 @@ class StreamingTranscriber {
                 (_c = (_b = this.listeners).error) === null || _c === void 0 ? void 0 : _c.call(_b, error);
             };
             this.socket.onmessage = ({ data }) => {
-                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
                 const message = JSON.parse(data.toString());
                 if ("error" in message) {
                     const err = new StreamingError(message.error);
@@ -999,8 +1005,12 @@ class StreamingTranscriber {
                         (_p = (_o = this.listeners).warning) === null || _p === void 0 ? void 0 : _p.call(_o, warning);
                         break;
                     }
+                    case "Heartbeat": {
+                        (_r = (_q = this.listeners).heartbeat) === null || _r === void 0 ? void 0 : _r.call(_q, message);
+                        break;
+                    }
                     case "Termination": {
-                        (_q = this.sessionTerminatedResolve) === null || _q === void 0 ? void 0 : _q.call(this);
+                        (_s = this.sessionTerminatedResolve) === null || _s === void 0 ? void 0 : _s.call(this);
                         break;
                     }
                 }

package/dist/types/asyncapi.generated.d.ts

@@ -6,7 +6,7 @@ export type AudioData = ArrayBufferLike;
  * The encoding of the audio data
  * @defaultValue "pcm_s16"le
  */
-export type AudioEncoding = "pcm_s16le" | "pcm_mulaw" | "opus" | "ogg_opus";
+export type AudioEncoding = "pcm_s16le" | "pcm_mulaw" | "opus" | "ogg_opus" | "aac";
 /**
  * Configure the threshold for how long to wait before ending an utterance. Default is 700ms.
  */

package/dist/types/streaming/index.d.ts

@@ -89,8 +89,8 @@ export type StreamingTranscriberParams = {
     connectionRetryDelay?: number;
     /**
      * Required for PCM encodings (and for dual-channel mode). May be omitted
-     * for Opus encodings (`opus`, `ogg_opus`) — the stream is self-describing
-     * and the server ignores the value.
+     * for self-describing encodings (`opus`, `ogg_opus`, `aac`) — the stream
+     * carries its own rate and the server ignores the value.
      */
     sampleRate?: number;
     encoding?: AudioEncoding;
@@ -103,6 +103,7 @@ export type StreamingTranscriberParams = {
     maxTurnSilence?: number;
     vadThreshold?: number;
     formatTurns?: boolean;
+    sessionHeartbeat?: boolean;
     filterProfanity?: boolean;
     keyterms?: string[];
     keytermsPrompt?: string[];
@@ -172,7 +173,7 @@ export type StreamingTranscriberParams = {
     /** Tuning for dual-channel attribution. Ignored when `channels` is unset. */
     channelAttribution?: ChannelAttributionParams;
 };
-export type StreamingEvents = "open" | "close" | "turn" | "speechStarted" | "llmGatewayResponse" | "speakerRevision" | "warning" | "vad" | "error";
+export type StreamingEvents = "open" | "close" | "turn" | "speechStarted" | "llmGatewayResponse" | "speakerRevision" | "warning" | "heartbeat" | "vad" | "error";
 export type StreamingListeners = {
     open?: (event: BeginEvent) => void;
     close?: (code: number, reason: string) => void;
@@ -181,6 +182,7 @@ export type StreamingListeners = {
     llmGatewayResponse?: (event: LLMGatewayResponseEvent) => void;
     speakerRevision?: (event: SpeakerRevisionEvent) => void;
     warning?: (event: WarningEvent) => void;
+    heartbeat?: (event: HeartbeatEvent) => void;
     vad?: (event: VadFrame) => void;
     error?: (error: Error) => void;
 };
@@ -266,6 +268,7 @@ export type StreamingUpdateConfiguration = {
     max_turn_silence?: number;
     vad_threshold?: number;
     format_turns?: boolean;
+    session_heartbeat?: boolean;
     keyterms_prompt?: string[];
     prompt?: string;
     agent_context?: string;
@@ -295,6 +298,13 @@ export type WarningEvent = {
     warning_code: number;
     warning: string;
 };
+export type HeartbeatEvent = {
+    type: "Heartbeat";
+    total_audio_received_ms: number;
+    total_duration_ms: number;
+    realtime_factor: number;
+    max_speech_probability: number;
+};
 export type LLMGatewayResponseEvent = {
     type: "LLMGatewayResponse";
     turn_order: number;
@@ -323,5 +333,5 @@ export type SpeakerRevisionEvent = {
     type: "SpeakerRevision";
     revisions: SpeakerRevisionItem[];
 };
-export type StreamingEventMessage = BeginEvent | TurnEvent | SpeechStartedEvent | TerminationEvent | LLMGatewayResponseEvent | SpeakerRevisionEvent | ErrorEvent | WarningEvent;
+export type StreamingEventMessage = BeginEvent | TurnEvent | SpeechStartedEvent | TerminationEvent | LLMGatewayResponseEvent | SpeakerRevisionEvent | ErrorEvent | WarningEvent | HeartbeatEvent;
 export type StreamingOperationMessage = StreamingUpdateConfiguration | StreamingForceEndpoint | StreamingKeepAlive | StreamingTerminateSession;

package/dist/workerd.mjs

@@ -39,7 +39,7 @@ if (typeof navigator !== "undefined" && navigator.userAgent) {
     defaultUserAgentString += navigator.userAgent;
 }
 const defaultUserAgent = {
-    sdk: { name: "JavaScript", version: "4.36.3" },
+    sdk: { name: "JavaScript", version: "4.36.4" },
 };
 if (typeof process !== "undefined") {
     if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
@@ -1370,9 +1370,12 @@ class StreamingTranscriber {
         if (!(this.token || this.apiKey)) {
             throw new Error("API key or temporary token is required.");
         }
-        const isOpus = params.encoding === "opus" || params.encoding === "ogg_opus";
-        if (params.sampleRate === undefined && (!isOpus || params.channels)) {
-            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus" or "ogg_opus" (the Opus stream is self-describing) and dual-channel mode is not used.');
+        const isSelfDescribing = params.encoding === "opus" ||
+            params.encoding === "ogg_opus" ||
+            params.encoding === "aac";
+        if (params.sampleRate === undefined &&
+            (!isSelfDescribing || params.channels)) {
+            throw new Error('`sampleRate` is required; it may only be omitted when `encoding` is "opus", "ogg_opus", or "aac" (these streams are self-describing) and dual-channel mode is not used.');
         }
         if (params.channels) {
             if (params.channels.length !== 2) {
@@ -1450,6 +1453,9 @@ class StreamingTranscriber {
         if (this.params.formatTurns) {
             searchParams.set("format_turns", this.params.formatTurns.toString());
         }
+        if (this.params.sessionHeartbeat !== undefined) {
+            searchParams.set("session_heartbeat", this.params.sessionHeartbeat.toString());
+        }
         if (this.params.encoding) {
             searchParams.set("encoding", this.params.encoding.toString());
         }
@@ -1734,6 +1740,10 @@ class StreamingTranscriber {
                         this.listeners.warning?.(warning);
                         break;
                     }
+                    case "Heartbeat": {
+                        this.listeners.heartbeat?.(message);
+                        break;
+                    }
                     case "Termination": {
                         this.sessionTerminatedResolve?.();
                         break;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "4.36.3",
+  "version": "4.36.4",
   "description": "The AssemblyAI JavaScript SDK provides an easy-to-use interface for interacting with the AssemblyAI API, which supports async and real-time transcription, as well as the latest LeMUR models.",
   "engines": {
     "node": ">=18"

package/src/services/streaming/service.ts

@@ -20,6 +20,7 @@ import {
   StreamingForceEndpoint,
   StreamingKeepAlive,
   WarningEvent,
+  HeartbeatEvent,
 } from "../..";
 import type { VadDetector, VadFrame } from "../../types/streaming/dual-channel";
 import { EnergyVad } from "./energy-vad";
@@ -164,10 +165,16 @@ export class StreamingTranscriber {
       throw new Error("API key or temporary token is required.");
     }
 
-    const isOpus = params.encoding === "opus" || params.encoding === "ogg_opus";
-    if (params.sampleRate === undefined && (!isOpus || params.channels)) {
+    const isSelfDescribing =
+      params.encoding === "opus" ||
+      params.encoding === "ogg_opus" ||
+      params.encoding === "aac";
+    if (
+      params.sampleRate === undefined &&
+      (!isSelfDescribing || params.channels)
+    ) {
       throw new Error(
-        '`sampleRate` is required; it may only be omitted when `encoding` is "opus" or "ogg_opus" (the Opus stream is self-describing) and dual-channel mode is not used.',
+        '`sampleRate` is required; it may only be omitted when `encoding` is "opus", "ogg_opus", or "aac" (these streams are self-describing) and dual-channel mode is not used.',
       );
     }
 
@@ -283,6 +290,13 @@ export class StreamingTranscriber {
       searchParams.set("format_turns", this.params.formatTurns.toString());
     }
 
+    if (this.params.sessionHeartbeat !== undefined) {
+      searchParams.set(
+        "session_heartbeat",
+        this.params.sessionHeartbeat.toString(),
+      );
+    }
+
     if (this.params.encoding) {
       searchParams.set("encoding", this.params.encoding.toString());
     }
@@ -474,6 +488,7 @@ export class StreamingTranscriber {
     listener: (event: SpeakerRevisionEvent) => void,
   ): void;
   on(event: "warning", listener: (event: WarningEvent) => void): void;
+  on(event: "heartbeat", listener: (event: HeartbeatEvent) => void): void;
   on(event: "vad", listener: (event: VadFrame) => void): void;
   on(event: "error", listener: (error: Error) => void): void;
   on(event: "close", listener: (code: number, reason: string) => void): void;
@@ -693,6 +708,10 @@ Learn more at https://github.com/AssemblyAI/assemblyai-node-sdk/blob/main/docs/c
             this.listeners.warning?.(warning);
             break;
           }
+          case "Heartbeat": {
+            this.listeners.heartbeat?.(message);
+            break;
+          }
           case "Termination": {
             this.sessionTerminatedResolve?.();
             break;

package/src/types/asyncapi.generated.ts

@@ -25,7 +25,12 @@ export type AudioData = ArrayBufferLike;
  * The encoding of the audio data
  * @defaultValue "pcm_s16"le
  */
-export type AudioEncoding = "pcm_s16le" | "pcm_mulaw" | "opus" | "ogg_opus";
+export type AudioEncoding =
+  | "pcm_s16le"
+  | "pcm_mulaw"
+  | "opus"
+  | "ogg_opus"
+  | "aac";
 
 /**
  * Configure the threshold for how long to wait before ending an utterance. Default is 700ms.