Function LibraryApiFactory

Returns {
    deleteItem(requestParameters: LibraryApiDeleteItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    deleteItems(requestParameters?: LibraryApiDeleteItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    getAncestors(requestParameters: LibraryApiGetAncestorsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDto[]>;
    getCriticReviews(requestParameters: LibraryApiGetCriticReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
    getDownload(requestParameters: LibraryApiGetDownloadRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
    getFile(requestParameters: LibraryApiGetFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
    getItemCounts(requestParameters?: LibraryApiGetItemCountsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemCounts>;
    getLibraryOptionsInfo(requestParameters?: LibraryApiGetLibraryOptionsInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<LibraryOptionsResultDto>;
    getMediaFolders(requestParameters?: LibraryApiGetMediaFoldersRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
    getPhysicalPaths(options?: RawAxiosRequestConfig): AxiosPromise<string[]>;
    getSimilarAlbums(requestParameters: LibraryApiGetSimilarAlbumsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
    getSimilarArtists(requestParameters: LibraryApiGetSimilarArtistsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
    getSimilarItems(requestParameters: LibraryApiGetSimilarItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
    getSimilarMovies(requestParameters: LibraryApiGetSimilarMoviesRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
    getSimilarShows(requestParameters: LibraryApiGetSimilarShowsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
    getSimilarTrailers(requestParameters: LibraryApiGetSimilarTrailersRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
    getThemeMedia(requestParameters: LibraryApiGetThemeMediaRequest, options?: RawAxiosRequestConfig): AxiosPromise<AllThemeMediaResult>;
    getThemeSongs(requestParameters: LibraryApiGetThemeSongsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ThemeMediaResult>;
    getThemeVideos(requestParameters: LibraryApiGetThemeVideosRequest, options?: RawAxiosRequestConfig): AxiosPromise<ThemeMediaResult>;
    postAddedMovies(requestParameters?: LibraryApiPostAddedMoviesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    postAddedSeries(requestParameters?: LibraryApiPostAddedSeriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    postUpdatedMedia(requestParameters: LibraryApiPostUpdatedMediaRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    postUpdatedMovies(requestParameters?: LibraryApiPostUpdatedMoviesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    postUpdatedSeries(requestParameters?: LibraryApiPostUpdatedSeriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    refreshLibrary(options?: RawAxiosRequestConfig): AxiosPromise<void>;
}

• deleteItem:function

  • deleteItem(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: LibraryApiDeleteItemRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Deletes an item from the library and filesystem.

    Throws

• deleteItems:function

  • deleteItems(requestParameters?, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: LibraryApiDeleteItemsRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Deletes items from the library and filesystem.

    Throws

• getAncestors:function

  • getAncestors(requestParameters, options?): AxiosPromise<BaseItemDto[]>

  • Parameters

    • requestParameters: LibraryApiGetAncestorsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDto[]>

    Summary

    Gets all parents of an item.

    Throws

• getCriticReviews:function

  • getCriticReviews(requestParameters, options?): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetCriticReviewsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Summary

    Gets critic review for an item.

    Deprecated

    Throws

• getDownload:function

  • getDownload(requestParameters, options?): AxiosPromise<File>

  • Parameters

    • requestParameters: LibraryApiGetDownloadRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<File>

    Summary

    Downloads item media.

    Throws

• getFile:function

  • getFile(requestParameters, options?): AxiosPromise<File>

  • Parameters

    • requestParameters: LibraryApiGetFileRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<File>

    Summary

    Get the original file of an item.

    Throws

• getItemCounts:function

  • getItemCounts(requestParameters?, options?): AxiosPromise<ItemCounts>

  • Parameters

    • requestParameters: LibraryApiGetItemCountsRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ItemCounts>

    Summary

    Get item counts.

    Throws

• getLibraryOptionsInfo:function

  • getLibraryOptionsInfo(requestParameters?, options?): AxiosPromise<LibraryOptionsResultDto>

  • Parameters

    • requestParameters: LibraryApiGetLibraryOptionsInfoRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<LibraryOptionsResultDto>

    Summary

    Gets the library options info.

    Throws

• getMediaFolders:function

  • getMediaFolders(requestParameters?, options?): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetMediaFoldersRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Summary

    Gets all user media folders.

    Throws

• getPhysicalPaths:function

  • getPhysicalPaths(options?): AxiosPromise<string[]>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<string[]>

    Summary

    Gets a list of physical paths from virtual folders.

    Throws

• getSimilarAlbums:function

  • getSimilarAlbums(requestParameters, options?): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetSimilarAlbumsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Summary

    Gets similar items.

    Throws

• getSimilarArtists:function

  • getSimilarArtists(requestParameters, options?): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetSimilarArtistsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Summary

    Gets similar items.

    Throws

• getSimilarItems:function

  • getSimilarItems(requestParameters, options?): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetSimilarItemsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Summary

    Gets similar items.

    Throws

• getSimilarMovies:function

  • getSimilarMovies(requestParameters, options?): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetSimilarMoviesRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Summary

    Gets similar items.

    Throws

• getSimilarShows:function

  • getSimilarShows(requestParameters, options?): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetSimilarShowsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Summary

    Gets similar items.

    Throws

• getSimilarTrailers:function

  • getSimilarTrailers(requestParameters, options?): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: LibraryApiGetSimilarTrailersRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Summary

    Gets similar items.

    Throws

• getThemeMedia:function

  • getThemeMedia(requestParameters, options?): AxiosPromise<AllThemeMediaResult>

  • Parameters

    • requestParameters: LibraryApiGetThemeMediaRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<AllThemeMediaResult>

    Summary

    Get theme songs and videos for an item.

    Throws

• getThemeSongs:function

  • getThemeSongs(requestParameters, options?): AxiosPromise<ThemeMediaResult>

  • Parameters

    • requestParameters: LibraryApiGetThemeSongsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ThemeMediaResult>

    Summary

    Get theme songs for an item.

    Throws

• getThemeVideos:function

  • getThemeVideos(requestParameters, options?): AxiosPromise<ThemeMediaResult>

  • Parameters

    • requestParameters: LibraryApiGetThemeVideosRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ThemeMediaResult>

    Summary

    Get theme videos for an item.

    Throws

• postAddedMovies:function

  • postAddedMovies(requestParameters?, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: LibraryApiPostAddedMoviesRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Reports that new movies have been added by an external source.

    Throws

• postAddedSeries:function

  • postAddedSeries(requestParameters?, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: LibraryApiPostAddedSeriesRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Reports that new episodes of a series have been added by an external source.

    Throws

• postUpdatedMedia:function

  • postUpdatedMedia(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: LibraryApiPostUpdatedMediaRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Reports that new movies have been added by an external source.

    Throws

• postUpdatedMovies:function

  • postUpdatedMovies(requestParameters?, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: LibraryApiPostUpdatedMoviesRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Reports that new movies have been added by an external source.

    Throws

• postUpdatedSeries:function

  • postUpdatedSeries(requestParameters?, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: LibraryApiPostUpdatedSeriesRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Reports that new episodes of a series have been added by an external source.

    Throws

• refreshLibrary:function

  • refreshLibrary(options?): AxiosPromise<void>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Starts a library scan.

    Throws