@pouchy_ai/companion-sdk - v0.1.0
    Preparing search index...

    Interface CompanionCallOptions

    interface CompanionCallOptions {
        audioElement?: HTMLAudioElement;
        bargeIn?: boolean;
        onError?: (err: Error) => void;
        onSpeakingChange?: (speaking: boolean) => void;
        onTranscript?: (e: { role: "user" | "assistant"; text: string }) => void;
    }
    Index
    audioElement? bargeIn? onError? onSpeakingChange? onTranscript?
    audioElement?: HTMLAudioElement

    Element to route remote audio to. One is created if omitted.

    bargeIn?: boolean

    OPT-IN full duplex: keep the mic OPEN while the companion speaks so the user can interrupt mid-utterance (both providers' native VAD interruption then works). Default false = half-duplex — the mic is muted during agent speech, because on phone SPEAKERS browser echo cancellation does not fully remove the companion's own voice and it barges in on itself (the SDK-voice "说一句就断了" field report). Enable only where AEC actually holds: headphones, desktop, or devices you have verified.

    onError?: (err: Error) => void
    onSpeakingChange?: (speaking: boolean) => void
    onTranscript?: (e: { role: "user" | "assistant"; text: string }) => void

    Settings
    Member Visibility

    On This Page
    Properties