Interface PlayAudioOptions

interface PlayAudioOptions {
    audioContentType?: string;
    sampleRate?: number;
    id?: string;
    queuePlay?: boolean;
}

Properties

audioContentType?: string

Audio encoding: 'raw' (headerless L16) or 'wav'/'wave'. Default: 'raw'.

sampleRate?: number

Sample rate for raw audio. Default: stream's sampleRate.

id?: string

Optional ID — returned in the playDone event.

queuePlay?: boolean

If true, queue after current playback. If false (default), interrupt current.