foo-webview-sdk
    Preparing search index...

    Interface AudioGenerateFullWaveformSuccess

    Successful response from audio.generateFullWaveform.

    interface AudioGenerateFullWaveformSuccess {
        cached: boolean;
        channels?: number;
        duration?: number;
        maxAmplitude?: number;
        method: "rms" | "peak";
        path: string;
        resolution: number;
        sampleRate?: number;
        scale: "linear" | "db";
        signed: boolean;
        status: "pending" | "ready";
        success: true;
        taskId?: string;
        waveform?: number[];
    }
    Index
    cached channels? duration? maxAmplitude? method path resolution sampleRate? scale signed status success taskId? waveform?
    cached: boolean

    The answer came from the cache.

    channels?: number

    ready answers: actual decoded PCM channel count.

    duration?: number

    ready answers: track length in seconds.

    maxAmplitude?: number

    ready answers: the largest value of the selected sequence before normalization, in linear full-scale units. On the linear scale waveform[i] * maxAmplitude restores the level; on db, dBFS is (v * 60 - 60) + 20 * log10(maxAmplitude).

    method: "rms" | "peak"

    As requested.

    path: string

    The requested path.

    resolution: number

    Point count in use.

    sampleRate?: number

    ready answers: actual decoded PCM sample rate in Hz, which can differ from the file's nominal sample rate.

    scale: "linear" | "db"

    As requested.

    signed: boolean

    As requested.

    status: "pending" | "ready"

    ready: the waveform is in this answer. pending: it arrives as an event for taskId.

    success: true

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

    taskId?: string

    Identifies the task in events and cancelFullWaveform; pending answers only.

    waveform?: number[]

    ready answers: the points, normalized by maxAmplitude.

    Settings
    Member Visibility

    On This Page
    Properties