Class KodiVideoLibraryNamespace

Constructors

constructor

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

Methods

Clean

Clean(showdialogs?: boolean): Promise<boolean>
Cleans the video library by removing entries for missing files.
Parameters
- showdialogs: boolean = true
  Whether to show dialogs during the cleaning process.
Returns Promise<boolean>
A promise resolving to a boolean indicating success.
- Defined in namespaces/videolibrary.ts:77

Export

Export(file: string): Promise<string>
Exports the video 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.
- Defined in namespaces/videolibrary.ts:89

GetEpisodeDetails

GetEpisodeDetails(
episodeid: string,
properties?: VideoProperty[],
): Promise<EpisodeDetailsResponse>
Retrieves detailed information about a specific episode.
Parameters
- episodeid: string
  The ID of the episode.
- Optionalproperties: VideoProperty[]
  Optional list of properties to retrieve.
Returns Promise<EpisodeDetailsResponse>
A promise resolving to the EpisodeDetails object.
- Defined in namespaces/videolibrary.ts:101

GetEpisodes

GetEpisodes(
    tvshowid: string,
    season?: number,
    properties?: VideoProperty[],
    limits?: ListLimits,
    sort?: ListSort,
    filter?: any,
): Promise<EpisodesResponse>
Retrieves a list of episodes with optional filtering and pagination.
Parameters
- tvshowid: string
  The ID of the TV show.
- Optionalseason: number
  The season number.
- Optionalproperties: VideoProperty[]
  Optional list of properties to retrieve.
- Optionallimits: ListLimits
  Optional pagination limits.
- Optionalsort: ListSort
  Optional sorting options.
- Optionalfilter: any
  Optional filter criteria.
Returns Promise<EpisodesResponse>
A promise resolving to the EpisodesResponse object.
- Defined in namespaces/videolibrary.ts:122

GetGenres

GetGenres(): Promise<GenresResponse>
Retrieves a list of genres.

Returns Promise<GenresResponse>
A promise resolving to the GenresResponse object.
- Defined in namespaces/videolibrary.ts:150

GetMovieDetails

GetMovieDetails(
movieid: string,
properties?: VideoProperty[],
): Promise<MovieDetailsResponse>
Retrieves detailed information about a specific movie.
Parameters
- movieid: string
  The ID of the movie.
- Optionalproperties: VideoProperty[]
  Optional list of properties to retrieve.
Returns Promise<MovieDetailsResponse>
A promise resolving to the MovieDetails object.
- Defined in namespaces/videolibrary.ts:161

GetMovies

GetMovies(
    properties?: VideoProperty[],
    limits?: ListLimits,
    sort?: ListSort,
    filter?: ListFilterMovies,
): Promise<MoviesResponse>
Retrieves a list of movies with optional filtering and pagination.
Parameters
- Optionalproperties: VideoProperty[]
  Optional list of properties to retrieve.
- Optionallimits: ListLimits
  Optional pagination limits.
- Optionalsort: ListSort
  Optional sorting options.
- Optionalfilter: ListFilterMovies
  Optional filter criteria.
Returns Promise<MoviesResponse>
A promise resolving to the MoviesResponse object.
- Defined in namespaces/videolibrary.ts:178

GetMusicVideoDetails

GetMusicVideoDetails(
musicvideoid: string,
properties?: VideoProperty[],
): Promise<MusicVideoDetailsResponse>
Retrieves detailed information about a specific music video.
Parameters
- musicvideoid: string
  The ID of the music video.
- Optionalproperties: VideoProperty[]
  Optional list of properties to retrieve.
Returns Promise<MusicVideoDetailsResponse>
A promise resolving to the MusicVideoDetails object.
- Defined in namespaces/videolibrary.ts:199

GetMusicVideos

GetMusicVideos(
    properties?: VideoProperty[],
    limits?: ListLimits,
    sort?: ListSort,
    filter?: ListFilterMusicVideos,
): Promise<MusicVideosResponse>
Retrieves a list of music videos with optional filtering and pagination.
Parameters
- Optionalproperties: VideoProperty[]
  Optional list of properties to retrieve.
- Optionallimits: ListLimits
  Optional pagination limits.
- Optionalsort: ListSort
  Optional sorting options.
- Optionalfilter: ListFilterMusicVideos
  Optional filter criteria.
Returns Promise<MusicVideosResponse>
A promise resolving to the MusicVideosResponse object.
- Defined in namespaces/videolibrary.ts:216

GetRecentlyAddedEpisodes

GetRecentlyAddedEpisodes(
limits?: ListLimits,
): Promise<RecentlyAddedEpisodesResponse>
Retrieves a list of recently added episodes.
Parameters
- Optionallimits: ListLimits
  Optional pagination limits.
Returns Promise<RecentlyAddedEpisodesResponse>
A promise resolving to the RecentlyAddedEpisodesResponse object.
- Defined in namespaces/videolibrary.ts:244

GetRecentlyAddedMovies

GetRecentlyAddedMovies(
limits?: ListLimits,
): Promise<RecentlyAddedMoviesResponse>
Retrieves a list of recently added movies.
Parameters
- Optionallimits: ListLimits
  Optional pagination limits.
Returns Promise<RecentlyAddedMoviesResponse>
A promise resolving to the RecentlyAddedMoviesResponse object.
- Defined in namespaces/videolibrary.ts:257

GetRecentlyAddedMusicVideos

GetRecentlyAddedMusicVideos(
limits?: ListLimits,
): Promise<RecentlyAddedMusicVideosResponse>
Retrieves a list of recently added music videos.
Parameters
- Optionallimits: ListLimits
  Optional pagination limits.
Returns Promise<RecentlyAddedMusicVideosResponse>
A promise resolving to the RecentlyAddedMusicVideosResponse object.
- Defined in namespaces/videolibrary.ts:270

GetSeasons

GetSeasons(tvshowid: string): Promise<SeasonsResponse>
Retrieves a list of seasons for a specific TV show.
Parameters
- tvshowid: string
  The ID of the TV show.
Returns Promise<SeasonsResponse>
A promise resolving to the SeasonsResponse object.
- Defined in namespaces/videolibrary.ts:283

GetTags

GetTags(): Promise<TagsResponse>
Retrieves a list of tags.

Returns Promise<TagsResponse>
A promise resolving to the TagsResponse object.
- Defined in namespaces/videolibrary.ts:336

GetTVShowDetails

GetTVShowDetails(
tvshowid: string,
properties?: VideoProperty[],
): Promise<TVShowDetailsResponse>
Retrieves detailed information about a specific TV show.
Parameters
- tvshowid: string
  The ID of the TV show.
- Optionalproperties: VideoProperty[]
  Optional list of properties to retrieve.
Returns Promise<TVShowDetailsResponse>
A promise resolving to the TVShowDetails object.
- Defined in namespaces/videolibrary.ts:295

GetTVShows

GetTVShows(
    properties?: VideoProperty[],
    limits?: ListLimits,
    sort?: ListSort,
    filter?: ListFilterTVShows,
): Promise<TVShowsResponse>
Retrieves a list of TV shows with optional filtering and pagination.
Parameters
- Optionalproperties: VideoProperty[]
  Optional list of properties to retrieve.
- Optionallimits: ListLimits
  Optional pagination limits.
- Optionalsort: ListSort
  Optional sorting options.
- Optionalfilter: ListFilterTVShows
  Optional filter criteria.
Returns Promise<TVShowsResponse>
A promise resolving to the TVShowsResponse object.
- Defined in namespaces/videolibrary.ts:312

GetVideoDetails

GetVideoDetails(
videoid: string,
properties?: VideoProperty[],
): Promise<VideoDetailsResponse>
Retrieves detailed information about a specific video.
Parameters
- videoid: string
  The ID of the video.
- Optionalproperties: VideoProperty[]
  Optional list of properties to retrieve.
Returns Promise<VideoDetailsResponse>
A promise resolving to the VideoDetails object.
- Defined in namespaces/videolibrary.ts:347

GetYears

GetYears(): Promise<YearsResponse>
Retrieves a list of years for which videos are available.

Returns Promise<YearsResponse>
A promise resolving to the YearsResponse object.
- Defined in namespaces/videolibrary.ts:360

Refresh

Refresh(): Promise<boolean>
Refreshes the video library by scanning for new content.

Returns Promise<boolean>
A promise resolving to a boolean indicating success.
- Defined in namespaces/videolibrary.ts:369

RemoveEpisode

RemoveEpisode(episodeid: string): Promise<boolean>
Removes a specific episode from the video library.
Parameters
- episodeid: string
  The ID of the episode to remove.
Returns Promise<boolean>
A promise resolving to a boolean indicating success.
- Defined in namespaces/videolibrary.ts:380

RemoveMovie

RemoveMovie(movieid: string): Promise<boolean>
Removes a specific movie from the video library.
Parameters
- movieid: string
  The ID of the movie to remove.
Returns Promise<boolean>
A promise resolving to a boolean indicating success.
- Defined in namespaces/videolibrary.ts:395

RemoveMusicVideo

RemoveMusicVideo(musicvideoid: string): Promise<boolean>
Removes a specific music video from the video library.
Parameters
- musicvideoid: string
  The ID of the music video to remove.
Returns Promise<boolean>
A promise resolving to a boolean indicating success.
- Defined in namespaces/videolibrary.ts:407

RemoveTVShow

RemoveTVShow(tvshowid: string): Promise<boolean>
Removes a specific TV show from the video library.
Parameters
- tvshowid: string
  The ID of the TV show to remove.
Returns Promise<boolean>
A promise resolving to a boolean indicating success.
- Defined in namespaces/videolibrary.ts:422

Scan

Scan(): Promise<boolean>
Scans the video library for new content.

Returns Promise<boolean>
A promise resolving to a boolean indicating if the scan was successful.
- Defined in namespaces/videolibrary.ts:436

SetEpisodeDetails

SetEpisodeDetails(
episodeid: string,
properties: Partial<EpisodeDetails>,
): Promise<boolean>
Updates the details of a specific episode.
Parameters
- episodeid: string
  The ID of the episode to update.
- properties: Partial<EpisodeDetails>
  The properties to update.
Returns Promise<boolean>
A promise resolving to a boolean indicating success.
- Defined in namespaces/videolibrary.ts:448

SetMovieDetails

SetMovieDetails(
movieid: string,
properties: Partial<MovieDetails>,
): Promise<boolean>
Updates the details of a specific movie.
Parameters
- movieid: string
  The ID of the movie to update.
- properties: Partial<MovieDetails>
  The properties to update.
Returns Promise<boolean>
A promise resolving to a boolean indicating success.
- Defined in namespaces/videolibrary.ts:467

SetMusicVideoDetails

SetMusicVideoDetails(
musicvideoid: string,
properties: Partial<MusicVideoDetails>,
): Promise<boolean>
Updates the details of a specific music video.
Parameters
- musicvideoid: string
  The ID of the music video to update.
- properties: Partial<MusicVideoDetails>
  The properties to update.
Returns Promise<boolean>
A promise resolving to a boolean indicating success.
- Defined in namespaces/videolibrary.ts:486

SetTVShowDetails

SetTVShowDetails(
tvshowid: string,
properties: Partial<TVShowDetails>,
): Promise<boolean>
Updates the details of a specific TV show.
Parameters
- tvshowid: string
  The ID of the TV show to update.
- properties: Partial<TVShowDetails>
  The properties to update.
Returns Promise<boolean>
A promise resolving to a boolean indicating success.
- Defined in namespaces/videolibrary.ts:505

Class KodiVideoLibraryNamespace

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns KodiVideoLibraryNamespace

Methods

Clean

Parameters

Returns Promise<boolean>

Export

Parameters

Returns Promise<string>

GetEpisodeDetails

Parameters

Returns Promise<EpisodeDetailsResponse>

GetEpisodes

Parameters

Returns Promise<EpisodesResponse>

GetGenres

Returns Promise<GenresResponse>

GetMovieDetails

Parameters

Returns Promise<MovieDetailsResponse>

GetMovies

Parameters

Returns Promise<MoviesResponse>

GetMusicVideoDetails

Parameters

Returns Promise<MusicVideoDetailsResponse>

GetMusicVideos

Parameters

Returns Promise<MusicVideosResponse>

GetRecentlyAddedEpisodes

Parameters

Returns Promise<RecentlyAddedEpisodesResponse>

GetRecentlyAddedMovies

Parameters

Returns Promise<RecentlyAddedMoviesResponse>

GetRecentlyAddedMusicVideos

Parameters

Returns Promise<RecentlyAddedMusicVideosResponse>

GetSeasons

Parameters

Returns Promise<SeasonsResponse>

GetTags

Returns Promise<TagsResponse>

GetTVShowDetails

Parameters

Returns Promise<TVShowDetailsResponse>

GetTVShows

Parameters

Returns Promise<TVShowsResponse>

GetVideoDetails

Parameters

Returns Promise<VideoDetailsResponse>

GetYears

Returns Promise<YearsResponse>

Refresh

Returns Promise<boolean>

RemoveEpisode

Parameters

Returns Promise<boolean>

RemoveMovie

Parameters

Returns Promise<boolean>

RemoveMusicVideo

Parameters

Returns Promise<boolean>

RemoveTVShow

Parameters

Returns Promise<boolean>

Scan

Returns Promise<boolean>

SetEpisodeDetails

Parameters

Returns Promise<boolean>

SetMovieDetails