AudioLibrary

public enum AudioLibrary

Audio Library information (Kodi Namespace)

getAlbums

  • getAlbums() Asynchronous

    Retrieve all albums (Kodi API)

    Declaration

    Swift

    public static func getAlbums() async -> [Audio.Details.Album]

    Return Value

    All albums in an Album array

getArtists

  • getArtists() Asynchronous

    Retrieve all artists (Kodi API)

    Declaration

    Swift

    public static func getArtists() async -> [Audio.Details.Artist]

    Return Value

    All artists in an Artist array

getArtistDetails

  • Retrieve details about a specific artist (Kodi API)

    Declaration

    Swift

    public static func getArtistDetails(artistID: Library.ID) async -> Audio.Details.Artist

    Parameters

    artistID

    The ID of the artist

    Return Value

    An Artist item

getGenres

  • getGenres() Asynchronous

    Retrieve all genres (Kodi API)

    Declaration

    Swift

    public static func getGenres() async -> [Library.Details.Genre]

    Return Value

    All genres in a Genre array

getSongs

  • Retrieve all songs (Kodi API)

    Limitations

    Loading songs from the host can be expensive!

    Examples

    The 10 last played songs:

        let lastPlayed = await AudioLibrary.getSongs(
        sort: List.Sort(method: .lastPlayed, order: .descending),
        limits: List.Limits(end: 10)
    )

    The tracks from a specific album:

        let albumTracks = await AudioLibrary.getSongs(
        filter: List.Filter(albumID: 3),
        sort: List.Sort(method: .track, order: .ascending)
    )

    Declaration

    Swift

    public static func getSongs(
    filter: List.Filter? = nil,
    sort: List.Sort = List.Sort(method: .track, order: .ascending),
    limits: List.Limits? = nil
) async -> [Audio.Details.Song]

    Parameters

    filter

    An optional filter
    sort

    The sort order
    limits

    The optional limits of the request

    Return Value

    All requested songs from the library

  • Retrieve all songs after a modification date (Kodi API)

    Declaration

    Swift

    public static func getSongs(modificationDate: String) async -> [Audio.Details.Song]

    Parameters

    modificationDate

    The date as a Kodi string

    Return Value

    The Song array after the modified date

getSongDetails

  • Retrieve details about a specific song (Kodi API)

    Declaration

    Swift

    public static func getSongDetails(songID: Library.ID) async -> Audio.Details.Song

    Parameters

    songID

    The ID of the song

    Return Value

    An Song item

setSongDetails

  • setSongDetails(song:) Asynchronous

    Update the given song with the given details (Kodi API)

    Declaration

    Swift

    public static func setSongDetails(song: Audio.Details.Song) async

    Parameters

    song

    The Song item

getProperties

  • getProperties() Asynchronous

    Retrieves the values of the music library properties (Kodi API)

    Declaration

    Swift

    public static func getProperties() async -> Audio.Property.Value

    Return Value

    The properties in a Value struct