Variable artworkConst

Type Declaration

• getAvailableArtwork: (path: string) => Promise<ArtworkGetAvailableArtworkResponse>

  List all available artwork types and files for a track.

• getAvailableTypes: (path?: string) => Promise<ArtworkGetAvailableTypesResponse>

  Without path the host reads the playing track.

• getBatch: (paths: string[], type?: AlbumArtType) => Promise<ArtworkGetBatchResponse>

  Retrieve album artwork for multiple track paths in one batch call.

• getByPath: (path: string, type?: AlbumArtType) => Promise<ArtworkGetByPathResponse>

  Retrieve album artwork for a track by its file path.

• getByPlaylistItem: (
      playlist: PlaylistRef,
      index: number,
      type?: AlbumArtType,
  ) => Promise<ArtworkGetByPlaylistItemResponse>

  A negative playlist index names the active playlist.

• getCurrent: (type?: AlbumArtType) => Promise<ArtworkGetCurrentResponse>

  Retrieve album artwork for the currently playing track.

• getFb2kUrl: (
      type?: AlbumArtType,
      options?: Pick<ArtworkGetFb2kUrlParams, "maxSize">,
  ) => Promise<ArtworkGetFb2kUrlResponse>

  Resolve a fb2k:// URL for the currently playing track suitable for direct <img src> consumption.

  The resolved URL is returned in the dataUrl field of the response envelope (see ArtworkGetFb2kUrlResponse).

• getFb2kUrlByPath: (
      path: string,
      type?: AlbumArtType,
      options?: Pick<ArtworkGetFb2kUrlByPathParams, "maxSize">,
  ) => Promise<ArtworkGetFb2kUrlByPathResponse>

  Resolve a fb2k:// URL for the track at path suitable for direct <img src> consumption.

  The resolved URL is returned in the dataUrl field of the response envelope (see ArtworkGetFb2kUrlByPathResponse).

• getFb2kUrlByPathBatch: (
      items: string[] | ArtworkBatchItem[],
      opts?: { maxSize?: number; type?: AlbumArtType },
  ) => Promise<ArtworkGetFb2kUrlByPathBatchResponse>

  Batch variant of getFb2kUrlByPath. Accepts either bare paths or ArtworkBatchItem objects whose own type / maxSize win over the batch-wide ones. Returns the full { artworks } envelope so callers can map per-row availability and error reasons.

• getFolderImages: (directory: string) => Promise<ArtworkGetFolderImagesResponse>

  List image files located within the specified folder.

• getForTrack: (
      path: string,
      type?: AlbumArtType,
      options?: ArtworkOptions,
  ) => Promise<ArtworkGetForTrackResponse>

  options is accepted for source compatibility only: the host reads the picture as stored and does not scale it, so maxSize is not sent.

• getLyrics: (path?: string) => Promise<ArtworkGetLyricsResponse>

  Without path the host reads the playing track.

• getMetadata: (path?: string) => Promise<ArtworkGetMetadataResponse>

  Without path the host reads the playing track.

• withMaxSize: (url: string, maxSize?: number) => string

  Append ?maxSize=N (or &maxSize=N) to a fb2k:// artwork URL. Returns the original URL untouched when maxSize is missing, non-positive, or the URL is empty.