foo-webview-sdk
    Preparing search index...

    Interface PcmHeader

    Decoded header of a shared PCM buffer.

    interface PcmHeader {
        capacityFrames: number;
        channels: number;
        epoch: number;
        flags: number;
        headerBytes: number;
        hostTimeMs: number;
        mode: 1 | 2;
        sampleRate: number;
        seq: number;
        startSeconds: number;
        version: number;
        writeFrames: number;
        writeSlot: number;
    }
    Index
    capacityFrames channels epoch flags headerBytes hostTimeMs mode sampleRate seq startSeconds version writeFrames writeSlot
    capacityFrames: number

    Frames the data region holds.

    channels: number
    epoch: number

    Ring: generation, starting at 1 and bumped when the stream format changes. One-shot: 1.

    flags: number

    Combination of the PCM_FLAG_* bits.

    headerBytes: number

    Byte offset of the samples: 64 for version 1, 192 for version 2.

    hostTimeMs: number

    Host Unix time in milliseconds of the latest write (one-shot: decode completion).

    mode: 1 | 2

    PCM_MODE_ONE_SHOT or PCM_MODE_RING.

    sampleRate: number

    Samples per second per channel.

    seq: number

    Seqlock counter: odd while the host is writing. One-shot buffers carry 2.

    startSeconds: number

    One-shot: track time in seconds of the first frame. Ring: 0.

    version: number

    Layout version, 1 or 2.

    writeFrames: number

    Frames written so far, wrapping at 2^32. One-shot buffers: the frame count.

    writeSlot: number

    Ring: slot the next frame goes to, 0 to capacityFrames - 1. One-shot: 0.

    Settings
    Member Visibility

    On This Page
    Properties