@twilio/video-node-sdk - v1.0.0-beta.1
    Preparing search index...

    Interface AudioFrame

    A PCM audio frame delivered by RemoteAudioTrack.frames. Always PCM_S16LE; frameId increments per frame.

    interface AudioFrame {
        captureTimestamp?: number;
        channels: number;
        format: "PCM_S16LE";
        frameId: number;
        frames: number;
        pcm: Buffer;
        rtpTimestamp?: number;
        sampleRate: number;
        timestamp: number;
        close?(): void;
    }
    Index
    captureTimestamp? channels format frameId frames pcm rtpTimestamp? sampleRate timestamp
    close?
    captureTimestamp?: number

    When the sender captured the frame, in microseconds, if reported.

    channels: number

    Number of interleaved channels in AudioFrame.pcm.

    format: "PCM_S16LE"

    Always 'PCM_S16LE'. The only sample format this SDK delivers.

    frameId: number

    SDK-generated monotonic per-track counter, for gap and drop detection.

    frames: number

    Number of samples per channel in AudioFrame.pcm.

    pcm: Buffer

    Interleaved signed 16-bit little-endian samples.

    rtpTimestamp?: number

    RTP timestamp from the packet that carried this frame, if available.

    sampleRate: number

    Samples per second.

    timestamp: number

    Local receive time, in microseconds on a monotonic clock.

    • Optional deterministic-release hint. Idempotent; reading pcm after close() throws.

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods