Skip to main content

AudioRecordingConfig

ug-js-sdk


ug-js-sdk / AudioRecordingConfig

Interface: AudioRecordingConfig

Defined in: user-input-manager/AudioRecorder.ts:23

Configuration options for audio recording.

Properties

sampleRate?

optional sampleRate: number

Defined in: user-input-manager/AudioRecorder.ts:25

Audio sample rate in Hz (default: 41000)


channels?

optional channels: number

Defined in: user-input-manager/AudioRecorder.ts:27

Number of audio channels (default: 1 for mono)


bitDepth?

optional bitDepth: number

Defined in: user-input-manager/AudioRecorder.ts:29

Audio bit depth (default: 16)


echoCancellation?

optional echoCancellation: boolean

Defined in: user-input-manager/AudioRecorder.ts:31

Enable echo cancellation via browser (default: true)


noiseSuppression?

optional noiseSuppression: boolean

Defined in: user-input-manager/AudioRecorder.ts:33

Enable noise suppression via browser (default: true)


autoGainControl?

optional autoGainControl: boolean

Defined in: user-input-manager/AudioRecorder.ts:35

Enable automatic gain control via browser (default: true)


timeslice?

optional timeslice: number

Defined in: user-input-manager/AudioRecorder.ts:37

MediaRecorder timeslice in ms - how often to emit audio chunks (default: 100)