jellyfin-api/org.jellyfin.sdk.api.operations/LibraryApi

LibraryApi

class LibraryApi(api: ApiClient) : Api

Constructors

Link copied to clipboard
constructor(api: ApiClient)

Functions

Link copied to clipboard
suspend fun deleteItem(itemId: <Error class: unknown class>): Response<Unit>

Deletes an item from the library and filesystem.

Link copied to clipboard
suspend fun deleteItems(ids: Collection<<Error class: unknown class>>? = emptyList()): Response<Unit>

Deletes items from the library and filesystem.

Link copied to clipboard
suspend fun getAncestors(itemId: <Error class: unknown class>, userId: <Error class: unknown class>? = null): Response<List<<Error class: unknown class>>>

Gets all parents of an item.

Link copied to clipboard
suspend fun getCriticReviews(itemId: String): Response<<Error class: unknown class>>

Gets critic review for an item.

Link copied to clipboard
suspend fun getDownload(itemId: <Error class: unknown class>): Response<<Error class: unknown class>>

Downloads item media.

Link copied to clipboard
fun getDownloadUrl(itemId: <Error class: unknown class>): String

Downloads item media.

Link copied to clipboard
suspend fun getFile(itemId: <Error class: unknown class>): Response<<Error class: unknown class>>

Get the original file of an item.

Link copied to clipboard
fun getFileUrl(itemId: <Error class: unknown class>): String

Get the original file of an item.

Link copied to clipboard
suspend fun getItemCounts(userId: <Error class: unknown class>? = null, isFavorite: Boolean? = null): Response<<Error class: unknown class>>

Get item counts.

Link copied to clipboard
suspend fun getLibraryOptionsInfo(libraryContentType: <Error class: unknown class>? = null, isNewLibrary: Boolean? = false): Response<<Error class: unknown class>>

Gets the library options info.

Link copied to clipboard
suspend fun getMediaFolders(isHidden: Boolean? = null): Response<<Error class: unknown class>>

Gets all user media folders.

Link copied to clipboard
suspend fun getPhysicalPaths(): Response<List<String>>

Gets a list of physical paths from virtual folders.

Link copied to clipboard
suspend fun getSimilarAlbums(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getSimilarAlbums(itemId: <Error class: unknown class>, excludeArtistIds: Collection<<Error class: unknown class>>? = emptyList(), userId: <Error class: unknown class>? = null, limit: Int? = null, fields: Collection<<Error class: unknown class>>? = emptyList()): Response<<Error class: unknown class>>

Gets similar items.

Link copied to clipboard
suspend fun getSimilarArtists(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getSimilarArtists(itemId: <Error class: unknown class>, excludeArtistIds: Collection<<Error class: unknown class>>? = emptyList(), userId: <Error class: unknown class>? = null, limit: Int? = null, fields: Collection<<Error class: unknown class>>? = emptyList()): Response<<Error class: unknown class>>

Gets similar items.

Link copied to clipboard
suspend fun getSimilarItems(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getSimilarItems(itemId: <Error class: unknown class>, excludeArtistIds: Collection<<Error class: unknown class>>? = emptyList(), userId: <Error class: unknown class>? = null, limit: Int? = null, fields: Collection<<Error class: unknown class>>? = emptyList()): Response<<Error class: unknown class>>

Gets similar items.

Link copied to clipboard
suspend fun getSimilarMovies(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getSimilarMovies(itemId: <Error class: unknown class>, excludeArtistIds: Collection<<Error class: unknown class>>? = emptyList(), userId: <Error class: unknown class>? = null, limit: Int? = null, fields: Collection<<Error class: unknown class>>? = emptyList()): Response<<Error class: unknown class>>

Gets similar items.

Link copied to clipboard
suspend fun getSimilarShows(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getSimilarShows(itemId: <Error class: unknown class>, excludeArtistIds: Collection<<Error class: unknown class>>? = emptyList(), userId: <Error class: unknown class>? = null, limit: Int? = null, fields: Collection<<Error class: unknown class>>? = emptyList()): Response<<Error class: unknown class>>

Gets similar items.

Link copied to clipboard
suspend fun getSimilarTrailers(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getSimilarTrailers(itemId: <Error class: unknown class>, excludeArtistIds: Collection<<Error class: unknown class>>? = emptyList(), userId: <Error class: unknown class>? = null, limit: Int? = null, fields: Collection<<Error class: unknown class>>? = emptyList()): Response<<Error class: unknown class>>

Gets similar items.

Link copied to clipboard
suspend fun getThemeMedia(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getThemeMedia(itemId: <Error class: unknown class>, userId: <Error class: unknown class>? = null, inheritFromParent: Boolean? = false, sortBy: Collection<<Error class: unknown class>>? = emptyList(), sortOrder: Collection<<Error class: unknown class>>? = emptyList()): Response<<Error class: unknown class>>

Get theme songs and videos for an item.

Link copied to clipboard
suspend fun getThemeSongs(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getThemeSongs(itemId: <Error class: unknown class>, userId: <Error class: unknown class>? = null, inheritFromParent: Boolean? = false, sortBy: Collection<<Error class: unknown class>>? = emptyList(), sortOrder: Collection<<Error class: unknown class>>? = emptyList()): Response<<Error class: unknown class>>

Get theme songs for an item.

Link copied to clipboard
suspend fun getThemeVideos(request: <Error class: unknown class>): Response<<Error class: unknown class>>
suspend fun getThemeVideos(itemId: <Error class: unknown class>, userId: <Error class: unknown class>? = null, inheritFromParent: Boolean? = false, sortBy: Collection<<Error class: unknown class>>? = emptyList(), sortOrder: Collection<<Error class: unknown class>>? = emptyList()): Response<<Error class: unknown class>>

Get theme videos for an item.

Link copied to clipboard
suspend fun postAddedMovies(tmdbId: String? = null, imdbId: String? = null): Response<Unit>

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

Link copied to clipboard
suspend fun postAddedSeries(tvdbId: String? = null): Response<Unit>

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

Link copied to clipboard
suspend fun postUpdatedMedia(data: <Error class: unknown class>): Response<Unit>

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

Link copied to clipboard
suspend fun postUpdatedMovies(tmdbId: String? = null, imdbId: String? = null): Response<Unit>

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

Link copied to clipboard
suspend fun postUpdatedSeries(tvdbId: String? = null): Response<Unit>

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

Link copied to clipboard
suspend fun refreshLibrary(): Response<Unit>

Starts a library scan.