Class KodiVideoLibraryNamespace

Constructors

constructor

new KodiVideoLibraryNamespace(
sendMessage: ISendMessage,
): KodiVideoLibraryNamespace
Parameters
- sendMessage: ISendMessage
Returns KodiVideoLibraryNamespace
- Defined in generated/namespaces/videolibrary.ts:89

Methods

Clean

Clean(params: VideoLibraryCleanParams): Promise<string>
Cleans the video library for non-existent items
Parameters
- params: VideoLibraryCleanParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:100

Export

Export(params: VideoLibraryExportParams): Promise<string>
Exports all items from the video library
Parameters
- params: VideoLibraryExportParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:109

GetAvailableArt

GetAvailableArt(
params: VideoLibraryGetAvailableArtParams,
): Promise<VideoLibraryGetAvailableArtResponse>
Retrieve all potential art URLs for a media item by art type
Parameters
- params: VideoLibraryGetAvailableArtParams
Returns Promise<VideoLibraryGetAvailableArtResponse>
VideoLibraryGetAvailableArtResponse
- Defined in generated/namespaces/videolibrary.ts:119

GetAvailableArtTypes

GetAvailableArtTypes(
params: VideoLibraryGetAvailableArtTypesParams,
): Promise<VideoLibraryGetAvailableArtTypesResponse>
Retrieve a list of potential art types for a media item
Parameters
- params: VideoLibraryGetAvailableArtTypesParams
Returns Promise<VideoLibraryGetAvailableArtTypesResponse>
VideoLibraryGetAvailableArtTypesResponse
- Defined in generated/namespaces/videolibrary.ts:128

GetEpisodeDetails

GetEpisodeDetails(
params: VideoLibraryGetEpisodeDetailsParams,
): Promise<VideoLibraryGetEpisodeDetailsResponse>
Retrieve details about a specific tv show episode
Parameters
- params: VideoLibraryGetEpisodeDetailsParams
Returns Promise<VideoLibraryGetEpisodeDetailsResponse>
VideoLibraryGetEpisodeDetailsResponse
- Defined in generated/namespaces/videolibrary.ts:138

GetEpisodes

GetEpisodes(
params: VideoLibraryGetEpisodesParams,
): Promise<VideoLibraryGetEpisodesResponse>
Retrieve all tv show episodes
Parameters
- params: VideoLibraryGetEpisodesParams
Returns Promise<VideoLibraryGetEpisodesResponse>
VideoLibraryGetEpisodesResponse
- Defined in generated/namespaces/videolibrary.ts:152

GetGenres

GetGenres(
params: VideoLibraryGetGenresParams,
): Promise<VideoLibraryGetGenresResponse>
Retrieve all genres
Parameters
- params: VideoLibraryGetGenresParams
Returns Promise<VideoLibraryGetGenresResponse>
VideoLibraryGetGenresResponse
- Defined in generated/namespaces/videolibrary.ts:164

GetInProgressTVShows

GetInProgressTVShows(
params: VideoLibraryGetInProgressTVShowsParams,
): Promise<VideoLibraryGetInProgressTVShowsResponse>
Retrieve all in progress tvshows
Parameters
- params: VideoLibraryGetInProgressTVShowsParams
Returns Promise<VideoLibraryGetInProgressTVShowsResponse>
VideoLibraryGetInProgressTVShowsResponse
- Defined in generated/namespaces/videolibrary.ts:175

GetMovieDetails

GetMovieDetails(
params: VideoLibraryGetMovieDetailsParams,
): Promise<VideoLibraryGetMovieDetailsResponse>
Retrieve details about a specific movie
Parameters
- params: VideoLibraryGetMovieDetailsParams
Returns Promise<VideoLibraryGetMovieDetailsResponse>
VideoLibraryGetMovieDetailsResponse
- Defined in generated/namespaces/videolibrary.ts:185

GetMovies

GetMovies(
params: VideoLibraryGetMoviesParams,
): Promise<VideoLibraryGetMoviesResponse>
Retrieve all movies
Parameters
- params: VideoLibraryGetMoviesParams
Returns Promise<VideoLibraryGetMoviesResponse>
VideoLibraryGetMoviesResponse
- Defined in generated/namespaces/videolibrary.ts:219

GetMovieSetDetails

GetMovieSetDetails(
params: VideoLibraryGetMovieSetDetailsParams,
): Promise<VideoLibraryGetMovieSetDetailsResponse>
Retrieve details about a specific movie set
Parameters
- params: VideoLibraryGetMovieSetDetailsParams
Returns Promise<VideoLibraryGetMovieSetDetailsResponse>
VideoLibraryGetMovieSetDetailsResponse
- Defined in generated/namespaces/videolibrary.ts:196

GetMovieSets

GetMovieSets(
params: VideoLibraryGetMovieSetsParams,
): Promise<VideoLibraryGetMovieSetsResponse>
Retrieve all movie sets
Parameters
- params: VideoLibraryGetMovieSetsParams
Returns Promise<VideoLibraryGetMovieSetsResponse>
VideoLibraryGetMovieSetsResponse
- Defined in generated/namespaces/videolibrary.ts:207

GetMusicVideoDetails

GetMusicVideoDetails(
params: VideoLibraryGetMusicVideoDetailsParams,
): Promise<VideoLibraryGetMusicVideoDetailsResponse>
Retrieve details about a specific music video
Parameters
- params: VideoLibraryGetMusicVideoDetailsParams
Returns Promise<VideoLibraryGetMusicVideoDetailsResponse>
VideoLibraryGetMusicVideoDetailsResponse
- Defined in generated/namespaces/videolibrary.ts:229

GetMusicVideos

GetMusicVideos(
params: VideoLibraryGetMusicVideosParams,
): Promise<VideoLibraryGetMusicVideosResponse>
Retrieve all music videos
Parameters
- params: VideoLibraryGetMusicVideosParams
Returns Promise<VideoLibraryGetMusicVideosResponse>
VideoLibraryGetMusicVideosResponse
- Defined in generated/namespaces/videolibrary.ts:241

GetRecentlyAddedEpisodes

GetRecentlyAddedEpisodes(
params: VideoLibraryGetRecentlyAddedEpisodesParams,
): Promise<VideoLibraryGetRecentlyAddedEpisodesResponse>
Retrieve all recently added tv episodes
Parameters
- params: VideoLibraryGetRecentlyAddedEpisodesParams
Returns Promise<VideoLibraryGetRecentlyAddedEpisodesResponse>
VideoLibraryGetRecentlyAddedEpisodesResponse
- Defined in generated/namespaces/videolibrary.ts:252

GetRecentlyAddedMovies

GetRecentlyAddedMovies(
params: VideoLibraryGetRecentlyAddedMoviesParams,
): Promise<VideoLibraryGetRecentlyAddedMoviesResponse>
Retrieve all recently added movies
Parameters
- params: VideoLibraryGetRecentlyAddedMoviesParams
Returns Promise<VideoLibraryGetRecentlyAddedMoviesResponse>
VideoLibraryGetRecentlyAddedMoviesResponse
- Defined in generated/namespaces/videolibrary.ts:263

GetRecentlyAddedMusicVideos

GetRecentlyAddedMusicVideos(
params: VideoLibraryGetRecentlyAddedMusicVideosParams,
): Promise<VideoLibraryGetRecentlyAddedMusicVideosResponse>
Retrieve all recently added music videos
Parameters
- params: VideoLibraryGetRecentlyAddedMusicVideosParams
Returns Promise<VideoLibraryGetRecentlyAddedMusicVideosResponse>
VideoLibraryGetRecentlyAddedMusicVideosResponse
- Defined in generated/namespaces/videolibrary.ts:274

GetSeasonDetails

GetSeasonDetails(
params: VideoLibraryGetSeasonDetailsParams,
): Promise<VideoLibraryGetSeasonDetailsResponse>
Retrieve details about a specific tv show season
Parameters
- params: VideoLibraryGetSeasonDetailsParams
Returns Promise<VideoLibraryGetSeasonDetailsResponse>
VideoLibraryGetSeasonDetailsResponse
- Defined in generated/namespaces/videolibrary.ts:284

GetSeasons

GetSeasons(
params: VideoLibraryGetSeasonsParams,
): Promise<VideoLibraryGetSeasonsResponse>
Retrieve all tv seasons
Parameters
- params: VideoLibraryGetSeasonsParams
Returns Promise<VideoLibraryGetSeasonsResponse>
VideoLibraryGetSeasonsResponse
- Defined in generated/namespaces/videolibrary.ts:296

GetTags

GetTags(params: VideoLibraryGetTagsParams): Promise<VideoLibraryGetTagsResponse>
Retrieve all tags
Parameters
- params: VideoLibraryGetTagsParams
Returns Promise<VideoLibraryGetTagsResponse>
VideoLibraryGetTagsResponse
- Defined in generated/namespaces/videolibrary.ts:330

GetTVShowDetails

GetTVShowDetails(
params: VideoLibraryGetTVShowDetailsParams,
): Promise<VideoLibraryGetTVShowDetailsResponse>
Retrieve details about a specific tv show
Parameters
- params: VideoLibraryGetTVShowDetailsParams
Returns Promise<VideoLibraryGetTVShowDetailsResponse>
VideoLibraryGetTVShowDetailsResponse
- Defined in generated/namespaces/videolibrary.ts:306

GetTVShows

GetTVShows(
params: VideoLibraryGetTVShowsParams,
): Promise<VideoLibraryGetTVShowsResponse>
Retrieve all tv shows
Parameters
- params: VideoLibraryGetTVShowsParams
Returns Promise<VideoLibraryGetTVShowsResponse>
VideoLibraryGetTVShowsResponse
- Defined in generated/namespaces/videolibrary.ts:318

RefreshEpisode

RefreshEpisode(params: VideoLibraryRefreshEpisodeParams): Promise<string>
Refresh the given episode in the library
Parameters
- params: VideoLibraryRefreshEpisodeParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:341

RefreshMovie

RefreshMovie(params: VideoLibraryRefreshMovieParams): Promise<string>
Refresh the given movie in the library
Parameters
- params: VideoLibraryRefreshMovieParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:352

RefreshMusicVideo

RefreshMusicVideo(params: VideoLibraryRefreshMusicVideoParams): Promise<string>
Refresh the given music video in the library
Parameters
- params: VideoLibraryRefreshMusicVideoParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:363

RefreshTVShow

RefreshTVShow(params: VideoLibraryRefreshTVShowParams): Promise<string>
Refresh the given tv show in the library
Parameters
- params: VideoLibraryRefreshTVShowParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:375

RemoveEpisode

RemoveEpisode(params: VideoLibraryRemoveEpisodeParams): Promise<string>
Removes the given episode from the library
Parameters
- params: VideoLibraryRemoveEpisodeParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:384

RemoveMovie

RemoveMovie(params: VideoLibraryRemoveMovieParams): Promise<string>
Removes the given movie from the library
Parameters
- params: VideoLibraryRemoveMovieParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:393

RemoveMusicVideo

RemoveMusicVideo(params: VideoLibraryRemoveMusicVideoParams): Promise<string>
Removes the given music video from the library
Parameters
- params: VideoLibraryRemoveMusicVideoParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:402

RemoveTVShow

RemoveTVShow(params: VideoLibraryRemoveTVShowParams): Promise<string>
Removes the given tv show from the library
Parameters
- params: VideoLibraryRemoveTVShowParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:411

Scan

Scan(params: VideoLibraryScanParams): Promise<string>
Scans the video sources for new library items
Parameters
- params: VideoLibraryScanParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:421

SetEpisodeDetails

SetEpisodeDetails(params: VideoLibrarySetEpisodeDetailsParams): Promise<string>
Update the given episode with the given details
Parameters
- params: VideoLibrarySetEpisodeDetailsParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:452

SetMovieDetails

SetMovieDetails(params: VideoLibrarySetMovieDetailsParams): Promise<string>
Update the given movie with the given details
Parameters
- params: VideoLibrarySetMovieDetailsParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:494

SetMovieSetDetails

SetMovieSetDetails(
params: VideoLibrarySetMovieSetDetailsParams,
): Promise<string>
Update the given movie set with the given details
Parameters
- params: VideoLibrarySetMovieSetDetailsParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:506

SetMusicVideoDetails

SetMusicVideoDetails(
params: VideoLibrarySetMusicVideoDetailsParams,
): Promise<string>
Update the given music video with the given details
Parameters
- params: VideoLibrarySetMusicVideoDetailsParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:537

SetSeasonDetails

SetSeasonDetails(params: VideoLibrarySetSeasonDetailsParams): Promise<string>
Update the given season with the given details
Parameters
- params: VideoLibrarySetSeasonDetailsParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:549

SetTVShowDetails

SetTVShowDetails(params: VideoLibrarySetTVShowDetailsParams): Promise<string>
Update the given tvshow with the given details
Parameters
- params: VideoLibrarySetTVShowDetailsParams
Returns Promise<string>
string
- Defined in generated/namespaces/videolibrary.ts:582