Member Junction
    Preparing search index...

    Interface IRealtimePcmPlayback

    The playback contract for a client-owned realtime audio plane: schedules raw PCM16 chunks for gapless playout and reports whether audio is AUDIBLY playing. Production is RealtimePcmPlayback (Web Audio, playhead-clock scheduling); tests inject a fake with a controllable IsPlaying.

    Shared by every websocket driver whose audio plane is client-owned (Gemini Live, ElevenLabs Agents) — WebRTC drivers (OpenAI) get playback from the peer connection instead and don't use this.

    interface IRealtimePcmPlayback {
        IsPlaying: boolean;
        Close(): void;
        ConnectMediaElement?(element: HTMLMediaElement): void;
        CreateMeter?(): IRealtimeAudioMeter;
        Enqueue(pcm16: ArrayBuffer, mediaTimeMs?: number): void;
        Flush(): void;
        GetOutputStream?(): MediaStream;
    }

    Implemented by

    Index

    Properties

    IsPlaying

    Methods

    Close ConnectMediaElement? CreateMeter? Enqueue Flush GetOutputStream?

    Properties

    IsPlaying: boolean

    true while scheduled audio is audibly playing (playhead ahead of the context clock).

    Methods

    • OPTIONAL: plays a media element's audio through this engine's output, so the agent meter (CreateMeter) and the recording stream (GetOutputStream) carry it as they carry PCM: an avatar's voice is in its video. Once per element for each engine; later calls for the same element do nothing. An element shown in an earlier call works again in the next. Optional so test fakes stay valid; callers use playback.ConnectMediaElement?.(element).

      Parameters

      • element: HTMLMediaElement

      Returns void

    • Schedules a raw PCM16 mono chunk back-to-back after any already-queued audio.

      Parameters

      • pcm16: ArrayBuffer

        The chunk.

      • OptionalmediaTimeMs: number

        Where the chunk starts on the stream's media timeline (ms), when the driver knows it: a playback that is also an IPlaybackClock then reads out the media time of the audio heard. A chunk without one continues the chunk before it.

      Returns void

    • OPTIONAL: the agent's output audio as a MediaStream, so a host can mix the agent voice into a recording (issue #5153). Mirrors what WebRTC drivers get from the peer connection. Optional so test fakes and environments without MediaStreamAudioDestinationNode stay valid; callers use playback.GetOutputStream?.() ?? null.

      Returns MediaStream

    Settings

    Member Visibility

    On This Page

    Properties
    Methods