Interface RoomOutputOptions

interface RoomOutputOptions {
    audioEnabled: boolean;
    audioNumChannels: number;
    audioPublishOptions: TrackPublishOptions;
    audioSampleRate: number;
    queueSizeMs?: number;
    syncTranscription: boolean;
    transcriptionEnabled: boolean;
}

Properties

audioEnabled audioNumChannels audioPublishOptions audioSampleRate queueSizeMs? syncTranscription transcriptionEnabled

Properties

audioEnabled

audioEnabled: boolean

If not given, default to True.

audioNumChannels

audioNumChannels: number

audioPublishOptions

audioPublishOptions: TrackPublishOptions

The name of the audio track to publish. If not provided, default to "roomio_audio".

audioSampleRate

audioSampleRate: number

Optional queueSizeMs

queueSizeMs?: number

Maximum queue size in milliseconds for the audio output buffer. When TTS generates audio faster than real-time, a larger queue prevents early frames from being discarded by the ring buffer. Defaults to the AudioSource internal default (1000ms).

syncTranscription

syncTranscription: boolean

False to disable transcription synchronization with audio output. Otherwise, transcription is emitted as quickly as available.

transcriptionEnabled

transcriptionEnabled: boolean

If not given, default to True.

Settings

Member Visibility

Theme

On This Page

audioEnabledaudioNumChannelsaudioPublishOptionsaudioSampleRatequeueSizeMssyncTranscriptiontranscriptionEnabled