foo-webview-sdk
    Preparing search index...

    Interface AudioGetSpectrumDebugStateSuccess

    Successful response from audio.getSpectrumDebugState.

    interface AudioGetSpectrumDebugStateSuccess {
        active: boolean;
        beatIntervalMs: number | null;
        beatsCoalesced: number;
        beatSource: "standard" | "high-resolution" | null;
        callerHwnd: number;
        callerOwnsSubscription: boolean;
        callerWindowId: string;
        dispatchTargetCount: number;
        dispatchTargets: SpectrumDebugTarget[];
        effectiveBands: number;
        effectiveFftSize: number;
        effectiveFps: number;
        foregroundHwnd: number;
        foregroundIsExternal: boolean;
        foregroundPid: number;
        foregroundTitle: string;
        framesComputed: number;
        instanceCount: number;
        skipFrames: number;
        streamReady: boolean;
        subscriptionCount: number;
        subscriptions: SpectrumDebugSubscription[];
        success: true;
        timerHwnd: number;
        timerRunning: boolean;
    }
    Index
    active beatIntervalMs beatsCoalesced beatSource callerHwnd callerOwnsSubscription callerWindowId dispatchTargetCount dispatchTargets effectiveBands effectiveFftSize effectiveFps foregroundHwnd foregroundIsExternal foregroundPid foregroundTitle framesComputed instanceCount skipFrames streamReady subscriptionCount subscriptions success timerHwnd timerRunning
    active: boolean

    At least one spectrum subscription is registered.

    beatIntervalMs: number | null

    Current beat in milliseconds, 1000 / effectiveFps; null while the beat thread is not running.

    beatsCoalesced: number

    Beats dropped because the previous one had not reached the main thread yet; cumulative.

    beatSource: "standard" | "high-resolution" | null

    Timer of the beat thread; null while it is not running.

    callerHwnd: number

    Window handle of the calling page, as a number; 0 when unknown.

    callerOwnsSubscription: boolean

    The calling page owns at least one subscription.

    callerWindowId: string

    Window id of the calling page; empty when unknown.

    dispatchTargetCount: number

    Length of dispatchTargets.

    dispatchTargets: SpectrumDebugTarget[]

    Windows the pushed frames are delivered to.

    effectiveBands: number

    Largest band count requested among all subscriptions.

    effectiveFftSize: number

    Largest FFT size requested among all subscriptions; each still computes with its own.

    effectiveFps: number

    Largest frame rate requested among all subscriptions.

    foregroundHwnd: number

    Handle of the foreground window, as a number.

    foregroundIsExternal: boolean

    The foreground window belongs to another process, so the background frame limit applies.

    foregroundPid: number

    Process id of the foreground window.

    foregroundTitle: string

    Title of the foreground window.

    framesComputed: number

    FFTs computed since the host started; flat while playback is paused or stopped.

    instanceCount: number

    WebView2 instances in the component.

    skipFrames: number

    Ticks the pushed frames will skip because the last one ran over its interval.

    streamReady: boolean

    The visualization stream exists.

    subscriptionCount: number

    Length of subscriptions.

    subscriptions: SpectrumDebugSubscription[]

    Every spectrum subscription of every page.

    success: true

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

    timerHwnd: number

    Deprecated; always 0.

    timerRunning: boolean

    The beat thread that pushes frames is running.

    Settings
    Member Visibility

    On This Page
    Properties