@zoom/rtms
    Preparing search index...

    Interface AudioParams

    Configuration parameters for audio streams with sensible defaults

    Default values (work out-of-box for per-participant audio):

    • contentType: RAW_AUDIO (2)
    • codec: OPUS (4)
    • sampleRate: SR_48K (3)
    • channel: STEREO (2)
    • dataOpt: AUDIO_MULTI_STREAMS (2) - enables userId in audio metadata
    • duration: 20 ms
    • frameSize: 960 samples (48kHz × 20ms)

    Users can omit setAudioParams() entirely or override individual fields.

    interface AudioParams {
        channel?: number;
        codec?: number;
        contentType?: number;
        dataOpt?: number;
        duration?: number;
        frameSize?: number;
        sampleRate?: number;
    }
    Index

    Properties

    channel? codec? contentType? dataOpt? duration? frameSize? sampleRate?

    Properties

    channel?: number

    The number of audio channels (1=mono, 2=stereo) (default: STEREO = 2)

    codec?: number

    The audio codec to use (default: OPUS = 4)

    contentType?: number

    The type of audio content (default: RAW_AUDIO = 2)

    dataOpt?: number

    Additional data options for audio processing (default: AUDIO_MULTI_STREAMS = 2)

    duration?: number

    The duration of each audio frame in milliseconds (default: 20 ms)

    frameSize?: number

    The size of each audio frame in samples (default: 960 samples)

    sampleRate?: number

    The sample rate SR_8K = 0, SR_16K = 1, SR_32K = 2, SR_48K = 3 (default: SR_48K = 3)

    Settings

    Member Visibility

    On This Page

    Properties