Skip to main content

Interface: AudioMessageMetadata

Defined in: packages/sdk/src/types/chat-types.ts:311

Playback metadata stored alongside an audio assistant message.

Server-applied at runtime by rendered_speech.play_file_stream / the artifact handler. Re-read by the chat renderer for display (e.g. annotating the bubble with "guaranteed delivery" if the clip is non-interruptible).

Properties

allowInterrupt?

optional allowInterrupt: boolean

Defined in: packages/sdk/src/types/chat-types.ts:313

When false, the clip plays end-to-end ignoring barge-in.


hangUpOnAudioEnd?

optional hangUpOnAudioEnd: boolean

Defined in: packages/sdk/src/types/chat-types.ts:315

When true, the call hangs up immediately after the clip ends.


volume?

optional volume: number

Defined in: packages/sdk/src/types/chat-types.ts:317

Server-side gain percent in [0, 100]. 80 is unity.