foo-webview-sdk
    Preparing search index...

    Interface LyricsSaveOptions

    lyrics.save options: the host parameters other than the track path and the text, which the method takes positionally, with target also accepting a single destination.

    interface LyricsSaveOptions {
        filename?: string;
        format?: "lrc" | "txt";
        tagName?: string;
        target?: LyricsSaveTarget | LyricsSaveTarget[];
    }

    Hierarchy

    Index
    filename? format? tagName? target?
    filename?: string

    Exact file name, including any extension, for the file target. A non-empty value replaces the derived name and ignores format; empty means the default name. The same Windows filename rules and INVALID_PARAMS failure as lyrics.get apply.

    format?: "lrc" | "txt"

    Extension for the default sidecar name; ignored when filename is non-empty.

    "lrc"
    tagName?: string

    Tag the embedded target writes.

    "LYRICS"
    target?: LyricsSaveTarget | LyricsSaveTarget[]

    Save destination(s): file (default), embedded, all, or an array such as ['file', 'embedded'].

    Settings
    Member Visibility

    On This Page
    Properties