LiveKit JS Client SDK - v2.15.14
    Preparing search index...

    Interface AudioCaptureOptions

    interface AudioCaptureOptions {
        autoGainControl?: ConstrainBoolean;
        channelCount?: ConstrainULong;
        deviceId?: ConstrainDOMString;
        echoCancellation?: ConstrainBoolean;
        latency?: ConstrainDouble;
        noiseSuppression?: ConstrainBoolean;
        processor?: TrackProcessor<Audio, AudioProcessorOptions>;
        sampleRate?: ConstrainULong;
        sampleSize?: ConstrainULong;
        voiceIsolation?: ConstrainBoolean;
    }
    Index

    Properties

    autoGainControl? channelCount? deviceId? echoCancellation? latency? noiseSuppression? processor? sampleRate? sampleSize? voiceIsolation?

    Properties

    autoGainControl?: ConstrainBoolean

    specifies whether automatic gain control is preferred and/or required

    channelCount?: ConstrainULong

    the channel count or range of channel counts which are acceptable and/or required

    deviceId?: ConstrainDOMString

    A ConstrainDOMString object specifying a device ID or an array of device IDs which are acceptable and/or required.

    echoCancellation?: ConstrainBoolean

    whether or not echo cancellation is preferred and/or required

    latency?: ConstrainDouble

    the latency or range of latencies which are acceptable and/or required.

    noiseSuppression?: ConstrainBoolean

    whether noise suppression is preferred and/or required.

    processor?: TrackProcessor<Audio, AudioProcessorOptions>

    initialize the track with a given processor

    sampleRate?: ConstrainULong

    the sample rate or range of sample rates which are acceptable and/or required.

    sampleSize?: ConstrainULong

    sample size or range of sample sizes which are acceptable and/or required.

    voiceIsolation?: ConstrainBoolean

    a stronger version of 'noiseSuppression', browser support is not widespread yet. If this is set (and supported) the value for 'noiseSuppression' will be ignored

    https://w3c.github.io/mediacapture-extensions/#voiceisolation-constraint

    Settings

    Member Visibility

    On This Page

    Properties