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, options?): 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>)>

    Summary

    Deletes an external lyric file.

    Throws

• downloadRemoteLyrics:function

  • downloadRemoteLyrics(itemId, lyricId, options?): 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>)>

    Summary

    Downloads a remote lyric.

    Throws

• getLyrics:function

  • getLyrics(itemId, options?): 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>)>

    Summary

    Gets an item's lyrics.

    Throws

• getRemoteLyrics:function

  • getRemoteLyrics(lyricId, options?): 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>)>

    Summary

    Gets the remote lyrics.

    Throws

• searchRemoteLyrics:function

  • searchRemoteLyrics(itemId, options?): 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[]>)>

    Summary

    Search remote lyrics.

    Throws

• uploadLyrics:function

  • uploadLyrics(itemId, fileName, body?, options?): 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>)>

    Summary

    Upload an external lyric file.

    Throws