foo-webview-sdk
    Preparing search index...

    Interface LyricsGetSuccess

    Successful response from lyrics.get.

    interface LyricsGetSuccess {
        available: boolean;
        lyrics?: string;
        path: string;
        source?: "file" | "embedded";
        sourcePath?: string;
        success: true;
        synced?: boolean;
        tagName?: string;
    }
    Index
    available lyrics? path source? sourcePath? success synced? tagName?
    available: boolean

    Whether lyrics were found.

    lyrics?: string

    The lyrics text; present when available is true.

    path: string

    The path looked up: as given, or the playing track's path including its subsong suffix.

    source?: "file" | "embedded"

    Where the lyrics came from; present when available is true.

    sourcePath?: string

    Full path of the sidecar file; present when source is file.

    success: true

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

    synced?: boolean

    Whether the text carries LRC timestamps; present when available is true.

    tagName?: string

    The tag that matched a type filter, one of LYRICS, UNSYNCED LYRICS, UNSYNCEDLYRICS, SYNCEDLYRICS, SYNCED LYRICS; present when source is embedded, type was not any and a known tag matched.

    Settings
    Member Visibility

    On This Page
    Properties