Class SpeechHandle

constructor

• new SpeechHandle(_id, _allowInterruptions, _inputDetails?, parent?): SpeechHandle

• Parameters

  • _id: string
  • _allowInterruptions: boolean
  • _inputDetails: InputDetails = DEFAULT_INPUT_DETAILS
  • Optional parent: SpeechHandle

  Returns SpeechHandle

Optional Readonly parent

Static SPEECH_PRIORITY_HIGH

Static SPEECH_PRIORITY_LOW

Static SPEECH_PRIORITY_NORMAL

allowInterruptions

• get allowInterruptions(): boolean

• Returns boolean

• set allowInterruptions(value): void

• Allow or disallow interruptions on this SpeechHandle.

  When set to false, the SpeechHandle will no longer accept any incoming interruption requests until re-enabled. If the handle is already interrupted, clearing interruptions is not allowed.

  Parameters

  • value: boolean

    true to allow interruptions, false to disallow

  Returns void

  Throws

  Error If attempting to disable interruptions when already interrupted

chatItems

• get chatItems(): ChatItem[]

• Returns ChatItem[]

id

• get id(): string

• Returns string

inputDetails

• get inputDetails(): InputDetails

• Returns InputDetails

interrupted

• get interrupted(): boolean

• Returns boolean

numSteps

• get numSteps(): number

• Returns number

scheduled

• get scheduled(): boolean

• Returns boolean

addDoneCallback

• addDoneCallback(callback): void

• Parameters

  • callback: ((sh) => void)
    • • (sh): void

      • Parameters

        • sh: SpeechHandle

        Returns void

  Returns void

done

• done(): boolean

• Returns boolean

exception

• exception(): unknown

• Returns the error that caused this SpeechHandle to complete, if any.

  Returns unknown

  Throws

  Error if the SpeechHandle is not done yet.

interrupt

• interrupt(force?): SpeechHandle

• Interrupt the current speech generation.

  Parameters

  • force: boolean = false

  Returns SpeechHandle

  The same speech handle that was interrupted.

  Throws

  Error If this speech handle is still running and does not allow interruptions.

removeDoneCallback

• removeDoneCallback(callback): void

• Parameters

  • callback: ((sh) => void)
    • • (sh): void

      • Parameters

        • sh: SpeechHandle

        Returns void

  Returns void

then

• then<R1, R2>(onFulfilled?, onRejected?): Promise<R1 | R2>

• Makes the SpeechHandle awaitable: await handle resolves to the handle itself once its playout has finished.

  Implementation note: naively returning this from onFulfilled would trigger infinite Promise assimilation recursion (the returned thenable gets unwrapped, calling .then() again, forever). We side-step this by shadowing .then with undefined on the instance for the duration of the synchronous Resolve(this) call. The spec-level IsCallable check reads undefined, fulfills the outer promise with this as a plain value, and we restore the prototype method immediately after.

  Type Parameters

  • R1 = ResolvedSpeechHandle
  • R2 = never

  Parameters

  • Optional onFulfilled: null | ((value) => R1 | PromiseLike<R1>)
  • Optional onRejected: null | ((reason) => R2 | PromiseLike<R2>)

  Returns Promise<R1 | R2>

waitForPlayout

• waitForPlayout(): Promise<void>

• Waits for the entire assistant turn to complete playback.

  This method waits until the assistant has fully finished speaking, including any finalization steps beyond initial response generation. This is appropriate to call when you want to ensure the speech output has entirely played out, including any tool calls and response follow-ups.

  Returns Promise<void>

  Throws

  SpeechHandleCircularWaitError if called on the SpeechHandle that owns the currently-running function tool — that would be a real circular wait (the tool is blocked waiting for this handle, and the handle cannot finish until the tool returns). Awaiting a different handle scheduled from inside a tool (e.g. session.generateReply().waitForPlayout()) is safe, because the main speech-queue loop frees the owning handle's generation slot via _markGenerationDone() before awaiting tool execution.

waitIfNotInterrupted

• waitIfNotInterrupted(aw): Promise<void>

• Parameters

  • aw: Promise<unknown>[]

  Returns Promise<void>

Static create

• create(options?): SpeechHandle

• Parameters

  • Optional options: {
        allowInterruptions?: boolean;
        inputDetails?: InputDetails;
        parent?: SpeechHandle;
        stepIndex?: number;
    }

    • Optional allowInterruptions?: boolean

    • Optional inputDetails?: InputDetails

    • Optional parent?: SpeechHandle

    • Optional stepIndex?: number

  Returns SpeechHandle