Function LyricsApiFp

Returns {
    deleteLyrics(
        itemId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    downloadRemoteLyrics(
        itemId: string,
        lyricId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>,
    >;
    getLyrics(
        itemId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>,
    >;
    getRemoteLyrics(
        lyricId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>,
    >;
    searchRemoteLyrics(
        itemId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RemoteLyricInfoDto[]>,
    >;
    uploadLyrics(
        itemId: string,
        fileName: string,
        body?: File,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>,
    >;
}

• deleteLyrics: function

  • deleteLyrics(
        itemId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • itemId: string

      The item id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• downloadRemoteLyrics: function

  • downloadRemoteLyrics(
        itemId: string,
        lyricId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>,
    >

    Parameters

    • itemId: string

      The item id.

    • lyricId: string

      The lyric id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>>

    Throws

• getLyrics: function

  • getLyrics(
        itemId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>,
    >

    Parameters

    • itemId: string

      Item id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>>

    Throws

• getRemoteLyrics: function

  • getRemoteLyrics(
        lyricId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>,
    >

    Parameters

    • lyricId: string

      The remote provider item id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>>

    Throws

• searchRemoteLyrics: function

  • searchRemoteLyrics(
        itemId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RemoteLyricInfoDto[]>,
    >

    Parameters

    • itemId: string

      The item id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RemoteLyricInfoDto[]>,
    >

    Throws

• uploadLyrics: function

  • uploadLyrics(
        itemId: string,
        fileName: string,
        body?: File,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>,
    >

    Parameters

    • itemId: string

      The item the lyric belongs to.

    • fileName: string

      Name of the file being uploaded.

    • Optionalbody: File
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>>

    Throws