@livekit/agents-plugin-openai 1.0.0-next.5 → 1.0.0-next.7

package/dist/tts.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/tts.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2024 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nimport { AudioByteStream, shortuuid, tts } from '@livekit/agents';\nimport type { AudioFrame } from '@livekit/rtc-node';\nimport { OpenAI } from 'openai';\nimport type { TTSModels, TTSVoices } from './models.js';\n\nconst OPENAI_TTS_SAMPLE_RATE = 24000;\nconst OPENAI_TTS_CHANNELS = 1;\n\nexport interface TTSOptions {\n  model: TTSModels | string;\n  voice: TTSVoices;\n  speed: number;\n  instructions?: string;\n  baseURL?: string;\n  client?: OpenAI;\n  apiKey?: string;\n}\n\nconst defaultTTSOptions: TTSOptions = {\n  apiKey: process.env.OPENAI_API_KEY,\n  model: 'tts-1',\n  voice: 'alloy',\n  speed: 1,\n};\n\nexport class TTS extends tts.TTS {\n  #opts: TTSOptions;\n  #client: OpenAI;\n  label = 'openai.TTS';\n\n  /**\n   * Create a new instance of OpenAI TTS.\n   *\n   * @remarks\n   * `apiKey` must be set to your OpenAI API key, either using the argument or by setting the\n   * `OPENAI_API_KEY` environmental variable.\n   */\n  constructor(opts: Partial<TTSOptions> = defaultTTSOptions) {\n    super(OPENAI_TTS_SAMPLE_RATE, OPENAI_TTS_CHANNELS, { streaming: false });\n\n    this.#opts = { ...defaultTTSOptions, ...opts };\n    if (this.#opts.apiKey === undefined) {\n      throw new Error('OpenAI API key is required, whether as an argument or as $OPENAI_API_KEY');\n    }\n\n    this.#client =\n      this.#opts.client ||\n      new OpenAI({\n        baseURL: opts.baseURL,\n        apiKey: opts.apiKey,\n      });\n  }\n\n  updateOptions(opts: { model?: TTSModels | string; voice?: TTSVoices; speed?: number }) {\n    this.#opts = { ...this.#opts, ...opts };\n  }\n\n  synthesize(text: string): ChunkedStream {\n    return new ChunkedStream(\n      this,\n      text,\n      this.#client.audio.speech.create({\n        input: text,\n        model: this.#opts.model,\n        voice: this.#opts.voice,\n        instructions: this.#opts.instructions,\n        response_format: 'pcm',\n        speed: this.#opts.speed,\n      }),\n    );\n  }\n\n  stream(): tts.SynthesizeStream {\n    throw new Error('Streaming is not supported on OpenAI TTS');\n  }\n}\n\nexport class ChunkedStream extends tts.ChunkedStream {\n  label = 'openai.ChunkedStream';\n  private stream: Promise<any>;\n\n  // set Promise<T> to any because OpenAI returns an annoying Response type\n  constructor(tts: TTS, text: string, stream: Promise<any>) {\n    super(text, tts);\n    this.stream = stream;\n  }\n\n  protected async run() {\n    const buffer = await this.stream.then((r) => r.arrayBuffer());\n    const requestId = shortuuid();\n    const audioByteStream = new AudioByteStream(OPENAI_TTS_SAMPLE_RATE, OPENAI_TTS_CHANNELS);\n    const frames = audioByteStream.write(buffer);\n\n    let lastFrame: AudioFrame | undefined;\n    const sendLastFrame = (segmentId: string, final: boolean) => {\n      if (lastFrame) {\n        this.queue.put({ requestId, segmentId, frame: lastFrame, final });\n        lastFrame = undefined;\n      }\n    };\n\n    for (const frame of frames) {\n      sendLastFrame(requestId, false);\n      lastFrame = frame;\n    }\n    sendLastFrame(requestId, true);\n\n    this.queue.close();\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,oBAAgD;AAEhD,oBAAuB;AAGvB,MAAM,yBAAyB;AAC/B,MAAM,sBAAsB;AAY5B,MAAM,oBAAgC;AAAA,EACpC,QAAQ,QAAQ,IAAI;AAAA,EACpB,OAAO;AAAA,EACP,OAAO;AAAA,EACP,OAAO;AACT;AAEO,MAAM,YAAY,kBAAI,IAAI;AAAA,EAC/B;AAAA,EACA;AAAA,EACA,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASR,YAAY,OAA4B,mBAAmB;AACzD,UAAM,wBAAwB,qBAAqB,EAAE,WAAW,MAAM,CAAC;AAEvE,SAAK,QAAQ,EAAE,GAAG,mBAAmB,GAAG,KAAK;AAC7C,QAAI,KAAK,MAAM,WAAW,QAAW;AACnC,YAAM,IAAI,MAAM,0EAA0E;AAAA,IAC5F;AAEA,SAAK,UACH,KAAK,MAAM,UACX,IAAI,qBAAO;AAAA,MACT,SAAS,KAAK;AAAA,MACd,QAAQ,KAAK;AAAA,IACf,CAAC;AAAA,EACL;AAAA,EAEA,cAAc,MAAyE;AACrF,SAAK,QAAQ,EAAE,GAAG,KAAK,OAAO,GAAG,KAAK;AAAA,EACxC;AAAA,EAEA,WAAW,MAA6B;AACtC,WAAO,IAAI;AAAA,MACT;AAAA,MACA;AAAA,MACA,KAAK,QAAQ,MAAM,OAAO,OAAO;AAAA,QAC/B,OAAO;AAAA,QACP,OAAO,KAAK,MAAM;AAAA,QAClB,OAAO,KAAK,MAAM;AAAA,QAClB,cAAc,KAAK,MAAM;AAAA,QACzB,iBAAiB;AAAA,QACjB,OAAO,KAAK,MAAM;AAAA,MACpB,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,SAA+B;AAC7B,UAAM,IAAI,MAAM,0CAA0C;AAAA,EAC5D;AACF;AAEO,MAAM,sBAAsB,kBAAI,cAAc;AAAA,EACnD,QAAQ;AAAA,EACA;AAAA;AAAA,EAGR,YAAYA,MAAU,MAAc,QAAsB;AACxD,UAAM,MAAMA,IAAG;AACf,SAAK,SAAS;AAAA,EAChB;AAAA,EAEA,MAAgB,MAAM;AACpB,UAAM,SAAS,MAAM,KAAK,OAAO,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC;AAC5D,UAAM,gBAAY,yBAAU;AAC5B,UAAM,kBAAkB,IAAI,8BAAgB,wBAAwB,mBAAmB;AACvF,UAAM,SAAS,gBAAgB,MAAM,MAAM;AAE3C,QAAI;AACJ,UAAM,gBAAgB,CAAC,WAAmB,UAAmB;AAC3D,UAAI,WAAW;AACb,aAAK,MAAM,IAAI,EAAE,WAAW,WAAW,OAAO,WAAW,MAAM,CAAC;AAChE,oBAAY;AAAA,MACd;AAAA,IACF;AAEA,eAAW,SAAS,QAAQ;AAC1B,oBAAc,WAAW,KAAK;AAC9B,kBAAY;AAAA,IACd;AACA,kBAAc,WAAW,IAAI;AAE7B,SAAK,MAAM,MAAM;AAAA,EACnB;AACF;","names":["tts"]}
+{"version":3,"sources":["../src/tts.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2024 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nimport { AudioByteStream, shortuuid, tts } from '@livekit/agents';\nimport type { AudioFrame } from '@livekit/rtc-node';\nimport { OpenAI } from 'openai';\nimport type { TTSModels, TTSVoices } from './models.js';\n\nconst OPENAI_TTS_SAMPLE_RATE = 24000;\nconst OPENAI_TTS_CHANNELS = 1;\n\nexport interface TTSOptions {\n  model: TTSModels | string;\n  voice: TTSVoices;\n  speed: number;\n  instructions?: string;\n  baseURL?: string;\n  client?: OpenAI;\n  apiKey?: string;\n}\n\nconst defaultTTSOptions: TTSOptions = {\n  apiKey: process.env.OPENAI_API_KEY,\n  model: 'tts-1',\n  voice: 'alloy',\n  speed: 1,\n};\n\nexport class TTS extends tts.TTS {\n  #opts: TTSOptions;\n  #client: OpenAI;\n  label = 'openai.TTS';\n\n  /**\n   * Create a new instance of OpenAI TTS.\n   *\n   * @remarks\n   * `apiKey` must be set to your OpenAI API key, either using the argument or by setting the\n   * `OPENAI_API_KEY` environment variable.\n   */\n  constructor(opts: Partial<TTSOptions> = defaultTTSOptions) {\n    super(OPENAI_TTS_SAMPLE_RATE, OPENAI_TTS_CHANNELS, { streaming: false });\n\n    this.#opts = { ...defaultTTSOptions, ...opts };\n    if (this.#opts.apiKey === undefined) {\n      throw new Error('OpenAI API key is required, whether as an argument or as $OPENAI_API_KEY');\n    }\n\n    this.#client =\n      this.#opts.client ||\n      new OpenAI({\n        baseURL: opts.baseURL,\n        apiKey: opts.apiKey,\n      });\n  }\n\n  updateOptions(opts: { model?: TTSModels | string; voice?: TTSVoices; speed?: number }) {\n    this.#opts = { ...this.#opts, ...opts };\n  }\n\n  synthesize(text: string): ChunkedStream {\n    return new ChunkedStream(\n      this,\n      text,\n      this.#client.audio.speech.create({\n        input: text,\n        model: this.#opts.model,\n        voice: this.#opts.voice,\n        instructions: this.#opts.instructions,\n        response_format: 'pcm',\n        speed: this.#opts.speed,\n      }),\n    );\n  }\n\n  stream(): tts.SynthesizeStream {\n    throw new Error('Streaming is not supported on OpenAI TTS');\n  }\n}\n\nexport class ChunkedStream extends tts.ChunkedStream {\n  label = 'openai.ChunkedStream';\n  private stream: Promise<any>;\n\n  // set Promise<T> to any because OpenAI returns an annoying Response type\n  constructor(tts: TTS, text: string, stream: Promise<any>) {\n    super(text, tts);\n    this.stream = stream;\n  }\n\n  protected async run() {\n    const buffer = await this.stream.then((r) => r.arrayBuffer());\n    const requestId = shortuuid();\n    const audioByteStream = new AudioByteStream(OPENAI_TTS_SAMPLE_RATE, OPENAI_TTS_CHANNELS);\n    const frames = audioByteStream.write(buffer);\n\n    let lastFrame: AudioFrame | undefined;\n    const sendLastFrame = (segmentId: string, final: boolean) => {\n      if (lastFrame) {\n        this.queue.put({ requestId, segmentId, frame: lastFrame, final });\n        lastFrame = undefined;\n      }\n    };\n\n    for (const frame of frames) {\n      sendLastFrame(requestId, false);\n      lastFrame = frame;\n    }\n    sendLastFrame(requestId, true);\n\n    this.queue.close();\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,oBAAgD;AAEhD,oBAAuB;AAGvB,MAAM,yBAAyB;AAC/B,MAAM,sBAAsB;AAY5B,MAAM,oBAAgC;AAAA,EACpC,QAAQ,QAAQ,IAAI;AAAA,EACpB,OAAO;AAAA,EACP,OAAO;AAAA,EACP,OAAO;AACT;AAEO,MAAM,YAAY,kBAAI,IAAI;AAAA,EAC/B;AAAA,EACA;AAAA,EACA,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASR,YAAY,OAA4B,mBAAmB;AACzD,UAAM,wBAAwB,qBAAqB,EAAE,WAAW,MAAM,CAAC;AAEvE,SAAK,QAAQ,EAAE,GAAG,mBAAmB,GAAG,KAAK;AAC7C,QAAI,KAAK,MAAM,WAAW,QAAW;AACnC,YAAM,IAAI,MAAM,0EAA0E;AAAA,IAC5F;AAEA,SAAK,UACH,KAAK,MAAM,UACX,IAAI,qBAAO;AAAA,MACT,SAAS,KAAK;AAAA,MACd,QAAQ,KAAK;AAAA,IACf,CAAC;AAAA,EACL;AAAA,EAEA,cAAc,MAAyE;AACrF,SAAK,QAAQ,EAAE,GAAG,KAAK,OAAO,GAAG,KAAK;AAAA,EACxC;AAAA,EAEA,WAAW,MAA6B;AACtC,WAAO,IAAI;AAAA,MACT;AAAA,MACA;AAAA,MACA,KAAK,QAAQ,MAAM,OAAO,OAAO;AAAA,QAC/B,OAAO;AAAA,QACP,OAAO,KAAK,MAAM;AAAA,QAClB,OAAO,KAAK,MAAM;AAAA,QAClB,cAAc,KAAK,MAAM;AAAA,QACzB,iBAAiB;AAAA,QACjB,OAAO,KAAK,MAAM;AAAA,MACpB,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,SAA+B;AAC7B,UAAM,IAAI,MAAM,0CAA0C;AAAA,EAC5D;AACF;AAEO,MAAM,sBAAsB,kBAAI,cAAc;AAAA,EACnD,QAAQ;AAAA,EACA;AAAA;AAAA,EAGR,YAAYA,MAAU,MAAc,QAAsB;AACxD,UAAM,MAAMA,IAAG;AACf,SAAK,SAAS;AAAA,EAChB;AAAA,EAEA,MAAgB,MAAM;AACpB,UAAM,SAAS,MAAM,KAAK,OAAO,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC;AAC5D,UAAM,gBAAY,yBAAU;AAC5B,UAAM,kBAAkB,IAAI,8BAAgB,wBAAwB,mBAAmB;AACvF,UAAM,SAAS,gBAAgB,MAAM,MAAM;AAE3C,QAAI;AACJ,UAAM,gBAAgB,CAAC,WAAmB,UAAmB;AAC3D,UAAI,WAAW;AACb,aAAK,MAAM,IAAI,EAAE,WAAW,WAAW,OAAO,WAAW,MAAM,CAAC;AAChE,oBAAY;AAAA,MACd;AAAA,IACF;AAEA,eAAW,SAAS,QAAQ;AAC1B,oBAAc,WAAW,KAAK;AAC9B,kBAAY;AAAA,IACd;AACA,kBAAc,WAAW,IAAI;AAE7B,SAAK,MAAM,MAAM;AAAA,EACnB;AACF;","names":["tts"]}

package/dist/tts.d.cts

@@ -18,7 +18,7 @@ export declare class TTS extends tts.TTS {
      *
      * @remarks
      * `apiKey` must be set to your OpenAI API key, either using the argument or by setting the
-     * `OPENAI_API_KEY` environmental variable.
+     * `OPENAI_API_KEY` environment variable.
      */
     constructor(opts?: Partial<TTSOptions>);
     updateOptions(opts: {

package/dist/tts.d.ts

@@ -18,7 +18,7 @@ export declare class TTS extends tts.TTS {
      *
      * @remarks
      * `apiKey` must be set to your OpenAI API key, either using the argument or by setting the
-     * `OPENAI_API_KEY` environmental variable.
+     * `OPENAI_API_KEY` environment variable.
      */
     constructor(opts?: Partial<TTSOptions>);
     updateOptions(opts: {

package/dist/tts.js

@@ -17,7 +17,7 @@ class TTS extends tts.TTS {
    *
    * @remarks
    * `apiKey` must be set to your OpenAI API key, either using the argument or by setting the
-   * `OPENAI_API_KEY` environmental variable.
+   * `OPENAI_API_KEY` environment variable.
    */
   constructor(opts = defaultTTSOptions) {
     super(OPENAI_TTS_SAMPLE_RATE, OPENAI_TTS_CHANNELS, { streaming: false });

package/dist/tts.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/tts.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2024 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nimport { AudioByteStream, shortuuid, tts } from '@livekit/agents';\nimport type { AudioFrame } from '@livekit/rtc-node';\nimport { OpenAI } from 'openai';\nimport type { TTSModels, TTSVoices } from './models.js';\n\nconst OPENAI_TTS_SAMPLE_RATE = 24000;\nconst OPENAI_TTS_CHANNELS = 1;\n\nexport interface TTSOptions {\n  model: TTSModels | string;\n  voice: TTSVoices;\n  speed: number;\n  instructions?: string;\n  baseURL?: string;\n  client?: OpenAI;\n  apiKey?: string;\n}\n\nconst defaultTTSOptions: TTSOptions = {\n  apiKey: process.env.OPENAI_API_KEY,\n  model: 'tts-1',\n  voice: 'alloy',\n  speed: 1,\n};\n\nexport class TTS extends tts.TTS {\n  #opts: TTSOptions;\n  #client: OpenAI;\n  label = 'openai.TTS';\n\n  /**\n   * Create a new instance of OpenAI TTS.\n   *\n   * @remarks\n   * `apiKey` must be set to your OpenAI API key, either using the argument or by setting the\n   * `OPENAI_API_KEY` environmental variable.\n   */\n  constructor(opts: Partial<TTSOptions> = defaultTTSOptions) {\n    super(OPENAI_TTS_SAMPLE_RATE, OPENAI_TTS_CHANNELS, { streaming: false });\n\n    this.#opts = { ...defaultTTSOptions, ...opts };\n    if (this.#opts.apiKey === undefined) {\n      throw new Error('OpenAI API key is required, whether as an argument or as $OPENAI_API_KEY');\n    }\n\n    this.#client =\n      this.#opts.client ||\n      new OpenAI({\n        baseURL: opts.baseURL,\n        apiKey: opts.apiKey,\n      });\n  }\n\n  updateOptions(opts: { model?: TTSModels | string; voice?: TTSVoices; speed?: number }) {\n    this.#opts = { ...this.#opts, ...opts };\n  }\n\n  synthesize(text: string): ChunkedStream {\n    return new ChunkedStream(\n      this,\n      text,\n      this.#client.audio.speech.create({\n        input: text,\n        model: this.#opts.model,\n        voice: this.#opts.voice,\n        instructions: this.#opts.instructions,\n        response_format: 'pcm',\n        speed: this.#opts.speed,\n      }),\n    );\n  }\n\n  stream(): tts.SynthesizeStream {\n    throw new Error('Streaming is not supported on OpenAI TTS');\n  }\n}\n\nexport class ChunkedStream extends tts.ChunkedStream {\n  label = 'openai.ChunkedStream';\n  private stream: Promise<any>;\n\n  // set Promise<T> to any because OpenAI returns an annoying Response type\n  constructor(tts: TTS, text: string, stream: Promise<any>) {\n    super(text, tts);\n    this.stream = stream;\n  }\n\n  protected async run() {\n    const buffer = await this.stream.then((r) => r.arrayBuffer());\n    const requestId = shortuuid();\n    const audioByteStream = new AudioByteStream(OPENAI_TTS_SAMPLE_RATE, OPENAI_TTS_CHANNELS);\n    const frames = audioByteStream.write(buffer);\n\n    let lastFrame: AudioFrame | undefined;\n    const sendLastFrame = (segmentId: string, final: boolean) => {\n      if (lastFrame) {\n        this.queue.put({ requestId, segmentId, frame: lastFrame, final });\n        lastFrame = undefined;\n      }\n    };\n\n    for (const frame of frames) {\n      sendLastFrame(requestId, false);\n      lastFrame = frame;\n    }\n    sendLastFrame(requestId, true);\n\n    this.queue.close();\n  }\n}\n"],"mappings":"AAGA,SAAS,iBAAiB,WAAW,WAAW;AAEhD,SAAS,cAAc;AAGvB,MAAM,yBAAyB;AAC/B,MAAM,sBAAsB;AAY5B,MAAM,oBAAgC;AAAA,EACpC,QAAQ,QAAQ,IAAI;AAAA,EACpB,OAAO;AAAA,EACP,OAAO;AAAA,EACP,OAAO;AACT;AAEO,MAAM,YAAY,IAAI,IAAI;AAAA,EAC/B;AAAA,EACA;AAAA,EACA,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASR,YAAY,OAA4B,mBAAmB;AACzD,UAAM,wBAAwB,qBAAqB,EAAE,WAAW,MAAM,CAAC;AAEvE,SAAK,QAAQ,EAAE,GAAG,mBAAmB,GAAG,KAAK;AAC7C,QAAI,KAAK,MAAM,WAAW,QAAW;AACnC,YAAM,IAAI,MAAM,0EAA0E;AAAA,IAC5F;AAEA,SAAK,UACH,KAAK,MAAM,UACX,IAAI,OAAO;AAAA,MACT,SAAS,KAAK;AAAA,MACd,QAAQ,KAAK;AAAA,IACf,CAAC;AAAA,EACL;AAAA,EAEA,cAAc,MAAyE;AACrF,SAAK,QAAQ,EAAE,GAAG,KAAK,OAAO,GAAG,KAAK;AAAA,EACxC;AAAA,EAEA,WAAW,MAA6B;AACtC,WAAO,IAAI;AAAA,MACT;AAAA,MACA;AAAA,MACA,KAAK,QAAQ,MAAM,OAAO,OAAO;AAAA,QAC/B,OAAO;AAAA,QACP,OAAO,KAAK,MAAM;AAAA,QAClB,OAAO,KAAK,MAAM;AAAA,QAClB,cAAc,KAAK,MAAM;AAAA,QACzB,iBAAiB;AAAA,QACjB,OAAO,KAAK,MAAM;AAAA,MACpB,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,SAA+B;AAC7B,UAAM,IAAI,MAAM,0CAA0C;AAAA,EAC5D;AACF;AAEO,MAAM,sBAAsB,IAAI,cAAc;AAAA,EACnD,QAAQ;AAAA,EACA;AAAA;AAAA,EAGR,YAAYA,MAAU,MAAc,QAAsB;AACxD,UAAM,MAAMA,IAAG;AACf,SAAK,SAAS;AAAA,EAChB;AAAA,EAEA,MAAgB,MAAM;AACpB,UAAM,SAAS,MAAM,KAAK,OAAO,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC;AAC5D,UAAM,YAAY,UAAU;AAC5B,UAAM,kBAAkB,IAAI,gBAAgB,wBAAwB,mBAAmB;AACvF,UAAM,SAAS,gBAAgB,MAAM,MAAM;AAE3C,QAAI;AACJ,UAAM,gBAAgB,CAAC,WAAmB,UAAmB;AAC3D,UAAI,WAAW;AACb,aAAK,MAAM,IAAI,EAAE,WAAW,WAAW,OAAO,WAAW,MAAM,CAAC;AAChE,oBAAY;AAAA,MACd;AAAA,IACF;AAEA,eAAW,SAAS,QAAQ;AAC1B,oBAAc,WAAW,KAAK;AAC9B,kBAAY;AAAA,IACd;AACA,kBAAc,WAAW,IAAI;AAE7B,SAAK,MAAM,MAAM;AAAA,EACnB;AACF;","names":["tts"]}
+{"version":3,"sources":["../src/tts.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2024 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nimport { AudioByteStream, shortuuid, tts } from '@livekit/agents';\nimport type { AudioFrame } from '@livekit/rtc-node';\nimport { OpenAI } from 'openai';\nimport type { TTSModels, TTSVoices } from './models.js';\n\nconst OPENAI_TTS_SAMPLE_RATE = 24000;\nconst OPENAI_TTS_CHANNELS = 1;\n\nexport interface TTSOptions {\n  model: TTSModels | string;\n  voice: TTSVoices;\n  speed: number;\n  instructions?: string;\n  baseURL?: string;\n  client?: OpenAI;\n  apiKey?: string;\n}\n\nconst defaultTTSOptions: TTSOptions = {\n  apiKey: process.env.OPENAI_API_KEY,\n  model: 'tts-1',\n  voice: 'alloy',\n  speed: 1,\n};\n\nexport class TTS extends tts.TTS {\n  #opts: TTSOptions;\n  #client: OpenAI;\n  label = 'openai.TTS';\n\n  /**\n   * Create a new instance of OpenAI TTS.\n   *\n   * @remarks\n   * `apiKey` must be set to your OpenAI API key, either using the argument or by setting the\n   * `OPENAI_API_KEY` environment variable.\n   */\n  constructor(opts: Partial<TTSOptions> = defaultTTSOptions) {\n    super(OPENAI_TTS_SAMPLE_RATE, OPENAI_TTS_CHANNELS, { streaming: false });\n\n    this.#opts = { ...defaultTTSOptions, ...opts };\n    if (this.#opts.apiKey === undefined) {\n      throw new Error('OpenAI API key is required, whether as an argument or as $OPENAI_API_KEY');\n    }\n\n    this.#client =\n      this.#opts.client ||\n      new OpenAI({\n        baseURL: opts.baseURL,\n        apiKey: opts.apiKey,\n      });\n  }\n\n  updateOptions(opts: { model?: TTSModels | string; voice?: TTSVoices; speed?: number }) {\n    this.#opts = { ...this.#opts, ...opts };\n  }\n\n  synthesize(text: string): ChunkedStream {\n    return new ChunkedStream(\n      this,\n      text,\n      this.#client.audio.speech.create({\n        input: text,\n        model: this.#opts.model,\n        voice: this.#opts.voice,\n        instructions: this.#opts.instructions,\n        response_format: 'pcm',\n        speed: this.#opts.speed,\n      }),\n    );\n  }\n\n  stream(): tts.SynthesizeStream {\n    throw new Error('Streaming is not supported on OpenAI TTS');\n  }\n}\n\nexport class ChunkedStream extends tts.ChunkedStream {\n  label = 'openai.ChunkedStream';\n  private stream: Promise<any>;\n\n  // set Promise<T> to any because OpenAI returns an annoying Response type\n  constructor(tts: TTS, text: string, stream: Promise<any>) {\n    super(text, tts);\n    this.stream = stream;\n  }\n\n  protected async run() {\n    const buffer = await this.stream.then((r) => r.arrayBuffer());\n    const requestId = shortuuid();\n    const audioByteStream = new AudioByteStream(OPENAI_TTS_SAMPLE_RATE, OPENAI_TTS_CHANNELS);\n    const frames = audioByteStream.write(buffer);\n\n    let lastFrame: AudioFrame | undefined;\n    const sendLastFrame = (segmentId: string, final: boolean) => {\n      if (lastFrame) {\n        this.queue.put({ requestId, segmentId, frame: lastFrame, final });\n        lastFrame = undefined;\n      }\n    };\n\n    for (const frame of frames) {\n      sendLastFrame(requestId, false);\n      lastFrame = frame;\n    }\n    sendLastFrame(requestId, true);\n\n    this.queue.close();\n  }\n}\n"],"mappings":"AAGA,SAAS,iBAAiB,WAAW,WAAW;AAEhD,SAAS,cAAc;AAGvB,MAAM,yBAAyB;AAC/B,MAAM,sBAAsB;AAY5B,MAAM,oBAAgC;AAAA,EACpC,QAAQ,QAAQ,IAAI;AAAA,EACpB,OAAO;AAAA,EACP,OAAO;AAAA,EACP,OAAO;AACT;AAEO,MAAM,YAAY,IAAI,IAAI;AAAA,EAC/B;AAAA,EACA;AAAA,EACA,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASR,YAAY,OAA4B,mBAAmB;AACzD,UAAM,wBAAwB,qBAAqB,EAAE,WAAW,MAAM,CAAC;AAEvE,SAAK,QAAQ,EAAE,GAAG,mBAAmB,GAAG,KAAK;AAC7C,QAAI,KAAK,MAAM,WAAW,QAAW;AACnC,YAAM,IAAI,MAAM,0EAA0E;AAAA,IAC5F;AAEA,SAAK,UACH,KAAK,MAAM,UACX,IAAI,OAAO;AAAA,MACT,SAAS,KAAK;AAAA,MACd,QAAQ,KAAK;AAAA,IACf,CAAC;AAAA,EACL;AAAA,EAEA,cAAc,MAAyE;AACrF,SAAK,QAAQ,EAAE,GAAG,KAAK,OAAO,GAAG,KAAK;AAAA,EACxC;AAAA,EAEA,WAAW,MAA6B;AACtC,WAAO,IAAI;AAAA,MACT;AAAA,MACA;AAAA,MACA,KAAK,QAAQ,MAAM,OAAO,OAAO;AAAA,QAC/B,OAAO;AAAA,QACP,OAAO,KAAK,MAAM;AAAA,QAClB,OAAO,KAAK,MAAM;AAAA,QAClB,cAAc,KAAK,MAAM;AAAA,QACzB,iBAAiB;AAAA,QACjB,OAAO,KAAK,MAAM;AAAA,MACpB,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,SAA+B;AAC7B,UAAM,IAAI,MAAM,0CAA0C;AAAA,EAC5D;AACF;AAEO,MAAM,sBAAsB,IAAI,cAAc;AAAA,EACnD,QAAQ;AAAA,EACA;AAAA;AAAA,EAGR,YAAYA,MAAU,MAAc,QAAsB;AACxD,UAAM,MAAMA,IAAG;AACf,SAAK,SAAS;AAAA,EAChB;AAAA,EAEA,MAAgB,MAAM;AACpB,UAAM,SAAS,MAAM,KAAK,OAAO,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC;AAC5D,UAAM,YAAY,UAAU;AAC5B,UAAM,kBAAkB,IAAI,gBAAgB,wBAAwB,mBAAmB;AACvF,UAAM,SAAS,gBAAgB,MAAM,MAAM;AAE3C,QAAI;AACJ,UAAM,gBAAgB,CAAC,WAAmB,UAAmB;AAC3D,UAAI,WAAW;AACb,aAAK,MAAM,IAAI,EAAE,WAAW,WAAW,OAAO,WAAW,MAAM,CAAC;AAChE,oBAAY;AAAA,MACd;AAAA,IACF;AAEA,eAAW,SAAS,QAAQ;AAC1B,oBAAc,WAAW,KAAK;AAC9B,kBAAY;AAAA,IACd;AACA,kBAAc,WAAW,IAAI;AAE7B,SAAK,MAAM,MAAM;AAAA,EACnB;AACF;","names":["tts"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/agents-plugin-openai",
-  "version": "1.0.0-next.5",
+  "version": "1.0.0-next.7",
   "description": "OpenAI plugin for LiveKit Node Agents",
   "main": "dist/index.js",
   "require": "dist/index.cjs",
@@ -30,9 +30,9 @@
     "@types/ws": "^8.5.10",
     "tsup": "^8.3.5",
     "typescript": "^5.0.0",
-    "@livekit/agents": "1.0.0-next.5",
-    "@livekit/agents-plugin-silero": "1.0.0-next.6",
-    "@livekit/agents-plugins-test": "1.0.0-next.5"
+    "@livekit/agents": "1.0.0-next.7",
+    "@livekit/agents-plugin-silero": "1.0.0-next.8",
+    "@livekit/agents-plugins-test": "1.0.0-next.7"
   },
   "dependencies": {
     "@livekit/mutex": "^1.1.1",
@@ -42,7 +42,7 @@
   },
   "peerDependencies": {
     "@livekit/rtc-node": "^0.13.12",
-    "@livekit/agents": "1.0.0-next.5"
+    "@livekit/agents": "1.0.0-next.7"
   },
   "scripts": {
     "build": "tsup --onSuccess \"pnpm build:types\"",

package/src/llm.ts

@@ -60,7 +60,7 @@ export class LLM extends llm.LLM {
    *
    * @remarks
    * `apiKey` must be set to your OpenAI API key, either using the argument or by setting the
-   * `OPENAI_API_KEY` environmental variable.
+   * `OPENAI_API_KEY` environment variable.
    */
   constructor(
     opts: Partial<LLMOptions> = defaultLLMOptions,
@@ -135,7 +135,7 @@ export class LLM extends llm.LLM {
    *
    * @remarks
    * `apiKey` must be set to your Cerebras API key, either using the argument or by setting the
-   * `CEREBRAS_API_KEY` environmental variable.
+   * `CEREBRAS_API_KEY` environment variable.
    */
   static withCerebras(
     opts: Partial<{
@@ -166,7 +166,7 @@ export class LLM extends llm.LLM {
    *
    * @remarks
    * `apiKey` must be set to your Fireworks API key, either using the argument or by setting the
-   * `FIREWORKS_API_KEY` environmental variable.
+   * `FIREWORKS_API_KEY` environment variable.
    */
   static withFireworks(opts: Partial<LLMOptions> = {}): LLM {
     opts.apiKey = opts.apiKey || process.env.FIREWORKS_API_KEY;
@@ -188,7 +188,7 @@ export class LLM extends llm.LLM {
    *
    * @remarks
    * `apiKey` must be set to your xAI API key, either using the argument or by setting the
-   * `XAI_API_KEY` environmental variable.
+   * `XAI_API_KEY` environment variable.
    */
   static withXAI(
     opts: Partial<{
@@ -217,7 +217,7 @@ export class LLM extends llm.LLM {
    *
    * @remarks
    * `apiKey` must be set to your Groq API key, either using the argument or by setting the
-   * `GROQ_API_KEY` environmental variable.
+   * `GROQ_API_KEY` environment variable.
    */
   static withGroq(
     opts: Partial<{
@@ -246,7 +246,7 @@ export class LLM extends llm.LLM {
    *
    * @remarks
    * `apiKey` must be set to your DeepSeek API key, either using the argument or by setting the
-   * `DEEPSEEK_API_KEY` environmental variable.
+   * `DEEPSEEK_API_KEY` environment variable.
    */
   static withDeepSeek(
     opts: Partial<{
@@ -277,7 +277,7 @@ export class LLM extends llm.LLM {
    *
    * @remarks
    * `apiKey` must be set to your OctoAI API key, either using the argument or by setting the
-   * `OCTOAI_TOKEN` environmental variable.
+   * `OCTOAI_TOKEN` environment variable.
    */
   static withOcto(
     opts: Partial<{
@@ -323,7 +323,7 @@ export class LLM extends llm.LLM {
    *
    * @remarks
    * `apiKey` must be set to your PerplexityAI API key, either using the argument or by setting the
-   * `PERPLEXITY_API_KEY` environmental variable.
+   * `PERPLEXITY_API_KEY` environment variable.
    */
   static withPerplexity(
     opts: Partial<{
@@ -354,7 +354,7 @@ export class LLM extends llm.LLM {
    *
    * @remarks
    * `apiKey` must be set to your TogetherAI API key, either using the argument or by setting the
-   * `TOGETHER_API_KEY` environmental variable.
+   * `TOGETHER_API_KEY` environment variable.
    */
   static withTogether(
     opts: Partial<{
@@ -385,7 +385,7 @@ export class LLM extends llm.LLM {
    *
    * @remarks
    * `apiKey` must be set to your Telnyx API key, either using the argument or by setting the
-   * `TELNYX_API_KEY` environmental variable.
+   * `TELNYX_API_KEY` environment variable.
    */
   static withTelnyx(
     opts: Partial<{
@@ -414,7 +414,7 @@ export class LLM extends llm.LLM {
    *
    * @remarks
    * `apiKey` must be set to your Meta Llama API key, either using the argument or by setting the
-   * `LLAMA_API_KEY` environmental variable.
+   * `LLAMA_API_KEY` environment variable.
    */
   static withMeta(
     opts: Partial<{
@@ -432,7 +432,7 @@ export class LLM extends llm.LLM {
 
     if (opts.apiKey === undefined) {
       throw new Error(
-        'Meta Llama API key is required, either as argument or set LLAMA_API_KEY environmental variable',
+        'Meta Llama API key is required, either as argument or set LLAMA_API_KEY environment variable',
       );
     }
 

package/src/realtime/realtime_model.ts

@@ -166,7 +166,7 @@ export class RealtimeModel extends llm.RealtimeModel {
 
     if (options.apiKey === '' && !isAzure) {
       throw new Error(
-        'OpenAI API key is required, either using the argument or by setting the OPENAI_API_KEY environmental variable',
+        'OpenAI API key is required, either using the argument or by setting the OPENAI_API_KEY environment variable',
       );
     }
 
@@ -174,7 +174,7 @@ export class RealtimeModel extends llm.RealtimeModel {
 
     if (!apiKey && !isAzure) {
       throw new Error(
-        'OpenAI API key is required, either using the argument or by setting the OPENAI_API_KEY environmental variable',
+        'OpenAI API key is required, either using the argument or by setting the OPENAI_API_KEY environment variable',
       );
     }
 
@@ -371,7 +371,7 @@ export class RealtimeSession extends llm.RealtimeSession {
   private pushedDurationMs: number = 0;
 
   #logger = log();
-  #task: Promise<void>;
+  #task: Task<void>;
   #closed = false;
 
   constructor(realtimeModel: RealtimeModel) {
@@ -379,7 +379,7 @@ export class RealtimeSession extends llm.RealtimeSession {
 
     this.oaiRealtimeModel = realtimeModel;
 
-    this.#task = this.#mainTask();
+    this.#task = Task.from(({ signal }) => this.#mainTask(signal));
 
     this.sendEvent(this.createSessionUpdateEvent());
   }
@@ -727,7 +727,7 @@ export class RealtimeSession extends llm.RealtimeSession {
     });
   }
 
-  async #mainTask(): Promise<void> {
+  async #mainTask(signal: AbortSignal): Promise<void> {
     let reconnecting = false;
     let numRetries = 0;
     let wsConn: WebSocket | null = null;
@@ -780,16 +780,20 @@ export class RealtimeSession extends llm.RealtimeSession {
     };
 
     reconnecting = false;
-    while (!this.#closed) {
+    while (!this.#closed && !signal.aborted) {
       this.#logger.debug('Creating WebSocket connection to OpenAI Realtime API');
       wsConn = await this.createWsConn();
+      if (signal.aborted) break;
 
       try {
         if (reconnecting) {
           await reconnect();
+          if (signal.aborted) break;
           numRetries = 0;
         }
+
         await this.runWs(wsConn);
+        if (signal.aborted) break;
       } catch (error) {
         if (!isAPIError(error)) {
           this.emitError({ error: error as Error, recoverable: false });
@@ -836,10 +840,13 @@ export class RealtimeSession extends llm.RealtimeSession {
 
   private async runWs(wsConn: WebSocket): Promise<void> {
     const forwardEvents = async (signal: AbortSignal): Promise<void> => {
+      const abortFuture = new Future<void>();
+      signal.addEventListener('abort', () => abortFuture.resolve());
+
       while (!this.#closed && wsConn.readyState === WebSocket.OPEN && !signal.aborted) {
         try {
-          const event = await this.messageChannel.get();
-          if (signal.aborted) {
+          const event = await Promise.race([this.messageChannel.get(), abortFuture.await]);
+          if (signal.aborted || abortFuture.done || event === undefined) {
             break;
           }
 

package/src/stt.ts

@@ -33,7 +33,7 @@ export class STT extends stt.STT {
    *
    * @remarks
    * `apiKey` must be set to your OpenAI API key, either using the argument or by setting the
-   * `OPENAI_API_KEY` environmental variable.
+   * `OPENAI_API_KEY` environment variable.
    */
   constructor(opts: Partial<STTOptions> = defaultSTTOptions) {
     super({ streaming: false, interimResults: false });
@@ -56,7 +56,7 @@ export class STT extends stt.STT {
    *
    * @remarks
    * `apiKey` must be set to your Groq API key, either using the argument or by setting the
-   * `GROQ_API_KEY` environmental variable.
+   * `GROQ_API_KEY` environment variable.
    */
   static withGroq(
     opts: Partial<{

package/src/tts.ts

@@ -36,7 +36,7 @@ export class TTS extends tts.TTS {
    *
    * @remarks
    * `apiKey` must be set to your OpenAI API key, either using the argument or by setting the
-   * `OPENAI_API_KEY` environmental variable.
+   * `OPENAI_API_KEY` environment variable.
    */
   constructor(opts: Partial<TTSOptions> = defaultTTSOptions) {
     super(OPENAI_TTS_SAMPLE_RATE, OPENAI_TTS_CHANNELS, { streaming: false });