VideoLibrary

public enum VideoLibrary

Video Library information (Kodi Namespace)

getEpisodes

  • getEpisodes(tvshowID:) Asynchronous

    Retrieve all episodes of a TV show (Kodi API)

    Declaration

    Swift

    public static func getEpisodes(tvshowID: Library.ID? = nil) async -> [Video.Details.Episode]

    Parameters

    tvshowID

    The optional TV show ID

    Return Value

    All TV shows in an Video/Details/Episode array

getEpisodeDetails

  • Retrieve details about a specific episode (Kodi API)

    Declaration

    Swift

    public static func getEpisodeDetails(episodeID: Library.ID) async -> Video.Details.Episode

    Parameters

    episodeID

    The ID of the episode

    Return Value

    A Video/Details/Episode item

setEpisodeDetails

  • Update the given episode with the given details (Kodi API)

    Declaration

    Swift

    public static func setEpisodeDetails(episode: Video.Details.Episode) async

    Parameters

    episode

    The Video/Details/Episode item

getGenres

  • getGenres(type:) Asynchronous

    Retrieve all genres (Kodi API)

    Declaration

    Swift

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

    Parameters

    type

    The type of Media

    Return Value

    All genres in a Genre array

getMovieSets

  • getMovieSets() Asynchronous

    Retrieve all movie sets (Kodi API)

    Declaration

    Swift

    public static func getMovieSets() async -> [Video.Details.MovieSet]

    Return Value

    All movie sets in an Video/Details/MovieSet array

getMovieSetDetails

  • Retrieve details about a specific movie set (Kodi API)

    Declaration

    Swift

    public static func getMovieSetDetails(setID: Library.ID) async -> Video.Details.MovieSet

    Return Value

    All movie sets in an Video/Details/MovieSet array

getMovies

  • getMovies() Asynchronous

    Retrieve all movies (Kodi API)

    Declaration

    Swift

    public static func getMovies() async -> [Video.Details.Movie]

    Return Value

    All movies in an Video/Details/Movie array

getMovieDetails

  • Retrieve details about a specific movie (Kodi API)

    Declaration

    Swift

    public static func getMovieDetails(movieID: Library.ID) async -> Video.Details.Movie

    Parameters

    movieID

    The ID of the movie

    Return Value

    A Video/Details/Movie item

setMovieDetails

  • Update the given movie with the given details (Kodi API)

    Declaration

    Swift

    public static func setMovieDetails(movie: Video.Details.Movie) async

    Parameters

    movie

    The Video/Details/Movie Item

getMusicVideos

  • getMusicVideos() Asynchronous

    Retrieve all music videos (Kodi API)

    Declaration

    Swift

    public static func getMusicVideos() async -> [Video.Details.MusicVideo]

    Return Value

    All music videos in an Video/Details/MusicVideo array

getMusicVideoDetails

  • Retrieve details about a specific music video (Kodi API)

    Declaration

    Swift

    public static func getMusicVideoDetails(musicVideoID: Library.ID) async -> Video.Details.MusicVideo

    Parameters

    musicVideoID

    The ID of the music video

    Return Value

    A Video/Details/MusicVideo Item

setMusicVideoDetails

  • Update the given music video with the given details (Kodi API)

    Declaration

    Swift

    public static func setMusicVideoDetails(musicVideo: Video.Details.MusicVideo) async

    Parameters

    musicVideo

    The Video/Details/MusicVideo item

refreshMusicVideo

  • Refresh the given music video in the library (Kodi API)

    Declaration

    Swift

    public static func refreshMusicVideo(musicVideo: Video.Details.MusicVideo) async

    Parameters

    musicVideo

    The Video/Details/MusicVideo item

getTVShows

  • getTVShows() Asynchronous

    Retrieve all TV shows (Kodi API)

    Declaration

    Swift

    public static func getTVShows() async -> [Video.Details.TVShow]

    Return Value

    All TV shows in an Video/Details/TVShow array

getTVShowDetails

  • Retrieve details about a specific tv show (Kodi API)

    Declaration

    Swift

    public static func getTVShowDetails(tvshowID: Library.ID) async -> Video.Details.TVShow

    Parameters

    tvshowID

    The ID of the TV show

    Return Value

    A Video/Details/TVShow Item

setTVShowDetails

  • Update the given tv show with the given details (Kodi API)

    Note

    Kodi does not send a notification if a TV show is changed

    Declaration

    Swift

    public static func setTVShowDetails(tvshow: Video.Details.TVShow) async

    Parameters

    tvshow

    The Video/Details/TVShow Item

VideoLibrary.getAllVideoGenres

  • getAllVideoGenres() Asynchronous

    Get all video genres from the Kodi host (SwiftlyKodi API)

    Declaration

    Swift

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

    Return Value

    All video genres from the Kodi host

VideoLibrary.getMusicVideoArtists

  • Get all Music Video Artists (SwiftlyKodi API)

    If the artist is not know in the Music database, a new Artist item will be created

    Declaration

    Swift

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

    Return Value

    All artists

VideoLibrary.getVideoLibraryStatus

  • Get the status of the Video Library (SwiftlyKodi API)

    Declaration

    Swift

    public static func getVideoLibraryStatus() async -> Library.Status

    Return Value

    Current status of all video items