@jellyfin/sdk
    Preparing search index...

    Function LyricsApiFp

    • LyricsApi - functional programming interface

      Parameters

      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
        • Parameters

          • itemId: string

            The item id.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • downloadRemoteLyrics: function
        • 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>>

      • getLyrics: function
        • Parameters

          • itemId: string

            Item id.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • getRemoteLyrics: function
        • Parameters

          • lyricId: string

            The remote provider item id.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • searchRemoteLyrics: function
        • Parameters

          • itemId: string

            The item id.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • uploadLyrics: function
        • 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>>