Class KodiAudioLibraryNamespace

Constructors

Methods

  • Cleans the audio library by removing entries for missing files.

    Returns Promise<boolean>

    A promise resolving to a boolean indicating success.

  • Exports the audio library to a specified file.

    Parameters

    • file: string

      The file path to export the library to.

    Returns Promise<string>

    A promise resolving to a string message upon success.

  • Retrieves detailed information about a specific album.

    Parameters

    • albumid: string

      The ID of the album.

    Returns Promise<AlbumDetails>

    A promise resolving to the AlbumDetails object.

  • Retrieves detailed information about a specific artist.

    Parameters

    • artistid: number

      The ID of the artist.

    Returns Promise<ArtistDetails>

    A promise resolving to the ArtistDetails object.

  • Retrieves detailed information about a specific song.

    Parameters

    • songid: string

      The ID of the song.

    Returns Promise<SongDetails>

    A promise resolving to the SongDetails object.

  • Retrieves a list of songs with optional filtering and pagination.

    Parameters

    • Optionalproperties: AudioProperty[]

      Optional list of properties to retrieve for each song.

    • Optionallimits: ListLimits

      Optional pagination limits.

    • Optionalsort: ListSort

      Optional sorting options.

    • Optionalfilter: any

      Optional filter criteria.

    • Optionalincludesingles: boolean

      Whether to include single songs.

    • Optionalallroles: boolean

      Whether to include all roles when filtering by artist.

    • Optionalsinglesonly: boolean

      Whether to include only single songs.

    Returns Promise<SongsResponse>

    A promise resolving to the list of songs and pagination details.

  • Refreshes the details of a specific album.

    Parameters

    • albumid: string

      The ID of the album to refresh.

    Returns Promise<boolean>

    A promise resolving to a boolean indicating success.

  • Refreshes the details of a specific artist.

    Parameters

    • artistid: number

      The ID of the artist to refresh.

    Returns Promise<boolean>

    A promise resolving to a boolean indicating success.

  • Scans the audio library for new additions.

    Returns Promise<boolean>

    A promise resolving to a boolean indicating if the scan was successful.

  • Updates the details of a specific album.

    Parameters

    • albumid: string

      The ID of the album to update.

    • properties: Partial<AlbumDetails>

      The properties to update.

    Returns Promise<boolean>

    A promise resolving to a boolean indicating success.

  • Updates the details of a specific artist.

    Parameters

    • artistid: number

      The ID of the artist to update.

    • properties: Partial<ArtistDetails>

      The properties to update.

    Returns Promise<boolean>

    A promise resolving to a boolean indicating success.

  • Updates the details of a specific song.

    Parameters

    • songid: string

      The ID of the song to update.

    • properties: Partial<SongDetails>

      The properties to update.

    Returns Promise<boolean>

    A promise resolving to a boolean indicating success.