foo-webview-sdk
    Preparing search index...

    Interface AudioSubscribeSpectrumSuccess

    Successful response from audio.subscribeSpectrum.

    interface AudioSubscribeSpectrumSuccess {
        backgroundThrottle: boolean;
        bands: number;
        channels: "mix" | "stereo";
        event: string;
        fftSize: number;
        fps: number;
        maxFrequency: number | null;
        minFrequency: number;
        output: "bands" | "bins";
        scale: "weighted" | "db";
        streamReady: boolean;
        subscriptionId: string;
        success: true;
    }
    Index
    backgroundThrottle bands channels event fftSize fps maxFrequency minFrequency output scale streamReady subscriptionId success
    backgroundThrottle: boolean

    As requested.

    bands: number

    Effective band count after clamping.

    channels: "mix" | "stereo"

    Channel layout registered.

    event: string

    Event name the frames arrive under.

    fftSize: number

    Requested FFT size; frames report the size actually used.

    fps: number

    Effective frame rate after clamping.

    maxFrequency: number | null

    Requested upper edge in Hz; null when the range follows half the stream's sample rate.

    minFrequency: number

    Lower edge of the range in Hz, as requested.

    output: "bands" | "bins"

    Output registered.

    scale: "weighted" | "db"

    Scale in use; always db for bin output.

    streamReady: boolean

    true once the visualization stream exists, which includes the stopped state; whether audio flows shows in the frames' state.

    subscriptionId: string

    Subscription identifier, as explicitly specified or derived by the host.

    success: true

    Always true here; a failed call resolves with ApiFailure instead.

    Settings
    Member Visibility

    On This Page
    Properties