start with public tags

Author: lukasIO

agents/etc/agents.api.md

@@ -7,6 +7,7 @@
 /// <reference types="node" />
 
 import { AudioFrame } from '@livekit/rtc-node';
+import type { AudioSource } from '@livekit/rtc-node';
 import type { E2EEOptions } from '@livekit/rtc-node';
 import { EventEmitter } from 'node:events';
 import { JobType } from '@livekit/protocol';
@@ -31,6 +32,16 @@ export interface Agent {
 // @public (undocumented)
 const AGENT_STATE_ATTRIBUTE = "lk.agent.state";
 
+// @public (undocumented)
+class AgentPlayout extends EventEmitter {
+    constructor(audioSource: AudioSource, sampleRate: number, numChannels: number, inFrameSize: number, outFrameSize: number);
+    // Warning: (ae-incompatible-release-tags) The symbol "play" is marked as @public, but its signature references "AsyncIterableQueue" which is marked as @internal
+    // Warning: (ae-incompatible-release-tags) The symbol "play" is marked as @public, but its signature references "AsyncIterableQueue" which is marked as @internal
+    //
+    // (undocumented)
+    play(itemId: string, contentIndex: number, transcriptionFwd: TranscriptionForwarder, textStream: AsyncIterableQueue<string>, audioStream: AsyncIterableQueue<AudioFrame>): PlayoutHandle;
+}
+
 // @public (undocumented)
 type AgentState = 'initializing' | 'thinking' | 'listening' | 'speaking';
 
@@ -297,7 +308,10 @@ declare namespace multimodal {
         RealtimeModel,
         AgentState,
         AGENT_STATE_ATTRIBUTE,
-        MultimodalAgent
+        MultimodalAgent,
+        proto_2 as proto,
+        PlayoutHandle,
+        AgentPlayout
     }
 }
 export { multimodal }
@@ -346,6 +360,35 @@ const oaiParams: (p: z.AnyZodObject) => {
     required_properties: string[];
 };
 
+// @public (undocumented)
+class PlayoutHandle extends EventEmitter {
+    constructor(audioSource: AudioSource, sampleRate: number, itemId: string, contentIndex: number, transcriptionFwd: TranscriptionForwarder);
+    // (undocumented)
+    get audioSamples(): number;
+    // (undocumented)
+    get contentIndex(): number;
+    // (undocumented)
+    get done(): boolean;
+    // @internal (undocumented)
+    doneFut: Future;
+    // (undocumented)
+    interrupt(): void;
+    // (undocumented)
+    get interrupted(): boolean;
+    // @internal (undocumented)
+    intFut: Future;
+    // (undocumented)
+    get itemId(): string;
+    // @internal (undocumented)
+    pushedDuration: number;
+    // (undocumented)
+    get textChars(): number;
+    // @internal (undocumented)
+    totalPlayedTime: number | undefined;
+    // @internal (undocumented)
+    transcriptionFwd: TranscriptionForwarder;
+}
+
 // @public (undocumented)
 abstract class Plugin_2 {
     constructor(title: string, version: string);
@@ -362,6 +405,9 @@ abstract class Plugin_2 {
 }
 export { Plugin_2 as Plugin }
 
+// @public (undocumented)
+const proto_2: {};
+
 // Warning: (ae-internal-missing-underscore) The name "Queue" should be prefixed with an underscore because the declaration is marked as @internal
 //
 // @internal (undocumented)

agents/src/multimodal/agent_playout.ts

@@ -6,7 +6,8 @@ import type { AudioSource } from '@livekit/rtc-node';
 import { EventEmitter } from 'node:events';
 import { AudioByteStream } from '../audio.js';
 import type { TranscriptionForwarder } from '../transcription.js';
-import { type AsyncIterableQueue, CancellablePromise, Future, gracefullyCancel } from '../utils.js';
+import { CancellablePromise, Future, gracefullyCancel } from '../utils.js';
+import type { AsyncIterableQueue } from '../utils.js';
 
 export const proto = {};
 

agents/src/multimodal/multimodal_agent.ts

@@ -21,7 +21,8 @@ import type * as llm from '../llm/index.js';
 import { log } from '../log.js';
 import { BasicTranscriptionForwarder } from '../transcription.js';
 import { findMicroTrackId } from '../utils.js';
-import { AgentPlayout, type PlayoutHandle } from './agent_playout.js';
+import type { PlayoutHandle } from './agent_playout.js';
+import { AgentPlayout } from './agent_playout.js';
 
 /**
  * @internal

plugins/openai/src/index.ts

@@ -1,6 +1,4 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-import * as realtime from './realtime/index.js';
-
-export { realtime };
+export * as realtime from './realtime/index.js';