jellyfin-sdk-swift/docs/LibraryAPI.md

LibraryAPI

All URIs are relative to http://localhost:8096

Method	HTTP request	Description
deleteItem	DELETE /Items/{itemId}	Deletes an item from the library and filesystem.
deleteItems	DELETE /Items	Deletes items from the library and filesystem.
getAncestors	GET /Items/{itemId}/Ancestors	Gets all parents of an item.
getCriticReviews	GET /Items/{itemId}/CriticReviews	Gets critic review for an item.
getDownload	GET /Items/{itemId}/Download	Downloads item media.
getFile	GET /Items/{itemId}/File	Get the original file of an item.
getItemCounts	GET /Items/Counts	Get item counts.
getLibraryOptionsInfo	GET /Libraries/AvailableOptions	Gets the library options info.
getMediaFolders	GET /Library/MediaFolders	Gets all user media folders.
getPhysicalPaths	GET /Library/PhysicalPaths	Gets a list of physical paths from virtual folders.
getSimilarAlbums	GET /Albums/{itemId}/Similar	Gets similar items.
getSimilarArtists	GET /Artists/{itemId}/Similar	Gets similar items.
getSimilarItems	GET /Items/{itemId}/Similar	Gets similar items.
getSimilarMovies	GET /Movies/{itemId}/Similar	Gets similar items.
getSimilarShows	GET /Shows/{itemId}/Similar	Gets similar items.
getSimilarTrailers	GET /Trailers/{itemId}/Similar	Gets similar items.
getThemeMedia	GET /Items/{itemId}/ThemeMedia	Get theme songs and videos for an item.
getThemeSongs	GET /Items/{itemId}/ThemeSongs	Get theme songs for an item.
getThemeVideos	GET /Items/{itemId}/ThemeVideos	Get theme videos for an item.
postAddedMovies	POST /Library/Movies/Added	Reports that new movies have been added by an external source.
postAddedSeries	POST /Library/Series/Added	Reports that new episodes of a series have been added by an external source.
postUpdatedMedia	POST /Library/Media/Updated	Reports that new movies have been added by an external source.
postUpdatedMovies	POST /Library/Movies/Updated	Reports that new movies have been added by an external source.
postUpdatedSeries	POST /Library/Series/Updated	Reports that new episodes of a series have been added by an external source.
refreshLibrary	POST /Library/Refresh	Starts a library scan.

deleteItem

    open class func deleteItem(itemId: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Deletes an item from the library and filesystem.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let itemId = "itemId_example" // String | The item id.

// Deletes an item from the library and filesystem.
LibraryAPI.deleteItem(itemId: itemId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
itemId	String	The item id.

Return type

Void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteItems

    open class func deleteItems(ids: [String]? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Deletes items from the library and filesystem.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let ids = ["inner_example"] // [String] | The item ids. (optional)

// Deletes items from the library and filesystem.
LibraryAPI.deleteItems(ids: ids) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
ids	**[String]**	The item ids.	[optional]

Return type

Void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAncestors

    open class func getAncestors(itemId: String, userId: String? = nil, completion: @escaping (_ data: [BaseItemDto]?, _ error: Error?) -> Void)

Gets all parents of an item.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let itemId = "itemId_example" // String | The item id.
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)

// Gets all parents of an item.
LibraryAPI.getAncestors(itemId: itemId, userId: userId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
itemId	String	The item id.
userId	String	Optional. Filter by user id, and attach user data.	[optional]

Return type

**[BaseItemDto]**

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCriticReviews

    open class func getCriticReviews(itemId: String, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Gets critic review for an item.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let itemId = "itemId_example" // String | 

// Gets critic review for an item.
LibraryAPI.getCriticReviews(itemId: itemId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
itemId	String

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDownload

    open class func getDownload(itemId: String, completion: @escaping (_ data: URL?, _ error: Error?) -> Void)

Downloads item media.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let itemId = "itemId_example" // String | The item id.

// Downloads item media.
LibraryAPI.getDownload(itemId: itemId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
itemId	String	The item id.

Return type

URL

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: video/*, audio/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFile

    open class func getFile(itemId: String, completion: @escaping (_ data: URL?, _ error: Error?) -> Void)

Get the original file of an item.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let itemId = "itemId_example" // String | The item id.

// Get the original file of an item.
LibraryAPI.getFile(itemId: itemId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
itemId	String	The item id.

Return type

URL

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: video/*, audio/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getItemCounts

    open class func getItemCounts(userId: String? = nil, isFavorite: Bool? = nil, completion: @escaping (_ data: ItemCounts?, _ error: Error?) -> Void)

Get item counts.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let userId = "userId_example" // String | Optional. Get counts from a specific user's library. (optional)
let isFavorite = true // Bool | Optional. Get counts of favorite items. (optional)

// Get item counts.
LibraryAPI.getItemCounts(userId: userId, isFavorite: isFavorite) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
userId	String	Optional. Get counts from a specific user's library.	[optional]
isFavorite	Bool	Optional. Get counts of favorite items.	[optional]

Return type

ItemCounts

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLibraryOptionsInfo

    open class func getLibraryOptionsInfo(libraryContentType: String? = nil, isNewLibrary: Bool? = nil, completion: @escaping (_ data: LibraryOptionsResultDto?, _ error: Error?) -> Void)

Gets the library options info.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let libraryContentType = "libraryContentType_example" // String | Library content type. (optional)
let isNewLibrary = true // Bool | Whether this is a new library. (optional) (default to false)

// Gets the library options info.
LibraryAPI.getLibraryOptionsInfo(libraryContentType: libraryContentType, isNewLibrary: isNewLibrary) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
libraryContentType	String	Library content type.	[optional]
isNewLibrary	Bool	Whether this is a new library.	[optional] [default to false]

Return type

LibraryOptionsResultDto

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMediaFolders

    open class func getMediaFolders(isHidden: Bool? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Gets all user media folders.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let isHidden = true // Bool | Optional. Filter by folders that are marked hidden, or not. (optional)

// Gets all user media folders.
LibraryAPI.getMediaFolders(isHidden: isHidden) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
isHidden	Bool	Optional. Filter by folders that are marked hidden, or not.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPhysicalPaths

    open class func getPhysicalPaths(completion: @escaping (_ data: [String]?, _ error: Error?) -> Void)

Gets a list of physical paths from virtual folders.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI


// Gets a list of physical paths from virtual folders.
LibraryAPI.getPhysicalPaths() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

[String]

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSimilarAlbums

    open class func getSimilarAlbums(itemId: String, excludeArtistIds: [String]? = nil, userId: String? = nil, limit: Int? = nil, fields: [ItemFields]? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Gets similar items.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let itemId = "itemId_example" // String | The item id.
let excludeArtistIds = ["inner_example"] // [String] | Exclude artist ids. (optional)
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. (optional)

// Gets similar items.
LibraryAPI.getSimilarAlbums(itemId: itemId, excludeArtistIds: excludeArtistIds, userId: userId, limit: limit, fields: fields) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
itemId	String	The item id.
excludeArtistIds	**[String]**	Exclude artist ids.	[optional]
userId	String	Optional. Filter by user id, and attach user data.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
fields	**[ItemFields]**	Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSimilarArtists

    open class func getSimilarArtists(itemId: String, excludeArtistIds: [String]? = nil, userId: String? = nil, limit: Int? = nil, fields: [ItemFields]? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Gets similar items.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let itemId = "itemId_example" // String | The item id.
let excludeArtistIds = ["inner_example"] // [String] | Exclude artist ids. (optional)
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. (optional)

// Gets similar items.
LibraryAPI.getSimilarArtists(itemId: itemId, excludeArtistIds: excludeArtistIds, userId: userId, limit: limit, fields: fields) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
itemId	String	The item id.
excludeArtistIds	**[String]**	Exclude artist ids.	[optional]
userId	String	Optional. Filter by user id, and attach user data.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
fields	**[ItemFields]**	Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSimilarItems

    open class func getSimilarItems(itemId: String, excludeArtistIds: [String]? = nil, userId: String? = nil, limit: Int? = nil, fields: [ItemFields]? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Gets similar items.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let itemId = "itemId_example" // String | The item id.
let excludeArtistIds = ["inner_example"] // [String] | Exclude artist ids. (optional)
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. (optional)

// Gets similar items.
LibraryAPI.getSimilarItems(itemId: itemId, excludeArtistIds: excludeArtistIds, userId: userId, limit: limit, fields: fields) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
itemId	String	The item id.
excludeArtistIds	**[String]**	Exclude artist ids.	[optional]
userId	String	Optional. Filter by user id, and attach user data.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
fields	**[ItemFields]**	Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSimilarMovies

    open class func getSimilarMovies(itemId: String, excludeArtistIds: [String]? = nil, userId: String? = nil, limit: Int? = nil, fields: [ItemFields]? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Gets similar items.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let itemId = "itemId_example" // String | The item id.
let excludeArtistIds = ["inner_example"] // [String] | Exclude artist ids. (optional)
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. (optional)

// Gets similar items.
LibraryAPI.getSimilarMovies(itemId: itemId, excludeArtistIds: excludeArtistIds, userId: userId, limit: limit, fields: fields) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
itemId	String	The item id.
excludeArtistIds	**[String]**	Exclude artist ids.	[optional]
userId	String	Optional. Filter by user id, and attach user data.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
fields	**[ItemFields]**	Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSimilarShows

    open class func getSimilarShows(itemId: String, excludeArtistIds: [String]? = nil, userId: String? = nil, limit: Int? = nil, fields: [ItemFields]? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Gets similar items.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let itemId = "itemId_example" // String | The item id.
let excludeArtistIds = ["inner_example"] // [String] | Exclude artist ids. (optional)
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. (optional)

// Gets similar items.
LibraryAPI.getSimilarShows(itemId: itemId, excludeArtistIds: excludeArtistIds, userId: userId, limit: limit, fields: fields) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
itemId	String	The item id.
excludeArtistIds	**[String]**	Exclude artist ids.	[optional]
userId	String	Optional. Filter by user id, and attach user data.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
fields	**[ItemFields]**	Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSimilarTrailers

    open class func getSimilarTrailers(itemId: String, excludeArtistIds: [String]? = nil, userId: String? = nil, limit: Int? = nil, fields: [ItemFields]? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Gets similar items.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let itemId = "itemId_example" // String | The item id.
let excludeArtistIds = ["inner_example"] // [String] | Exclude artist ids. (optional)
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. (optional)

// Gets similar items.
LibraryAPI.getSimilarTrailers(itemId: itemId, excludeArtistIds: excludeArtistIds, userId: userId, limit: limit, fields: fields) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
itemId	String	The item id.
excludeArtistIds	**[String]**	Exclude artist ids.	[optional]
userId	String	Optional. Filter by user id, and attach user data.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
fields	**[ItemFields]**	Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getThemeMedia

    open class func getThemeMedia(itemId: String, userId: String? = nil, inheritFromParent: Bool? = nil, completion: @escaping (_ data: AllThemeMediaResult?, _ error: Error?) -> Void)

Get theme songs and videos for an item.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let itemId = "itemId_example" // String | The item id.
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let inheritFromParent = true // Bool | Optional. Determines whether or not parent items should be searched for theme media. (optional) (default to false)

// Get theme songs and videos for an item.
LibraryAPI.getThemeMedia(itemId: itemId, userId: userId, inheritFromParent: inheritFromParent) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
itemId	String	The item id.
userId	String	Optional. Filter by user id, and attach user data.	[optional]
inheritFromParent	Bool	Optional. Determines whether or not parent items should be searched for theme media.	[optional] [default to false]

Return type

AllThemeMediaResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getThemeSongs

    open class func getThemeSongs(itemId: String, userId: String? = nil, inheritFromParent: Bool? = nil, completion: @escaping (_ data: ThemeMediaResult?, _ error: Error?) -> Void)

Get theme songs for an item.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let itemId = "itemId_example" // String | The item id.
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let inheritFromParent = true // Bool | Optional. Determines whether or not parent items should be searched for theme media. (optional) (default to false)

// Get theme songs for an item.
LibraryAPI.getThemeSongs(itemId: itemId, userId: userId, inheritFromParent: inheritFromParent) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
itemId	String	The item id.
userId	String	Optional. Filter by user id, and attach user data.	[optional]
inheritFromParent	Bool	Optional. Determines whether or not parent items should be searched for theme media.	[optional] [default to false]

Return type

ThemeMediaResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getThemeVideos

    open class func getThemeVideos(itemId: String, userId: String? = nil, inheritFromParent: Bool? = nil, completion: @escaping (_ data: ThemeMediaResult?, _ error: Error?) -> Void)

Get theme videos for an item.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let itemId = "itemId_example" // String | The item id.
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let inheritFromParent = true // Bool | Optional. Determines whether or not parent items should be searched for theme media. (optional) (default to false)

// Get theme videos for an item.
LibraryAPI.getThemeVideos(itemId: itemId, userId: userId, inheritFromParent: inheritFromParent) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
itemId	String	The item id.
userId	String	Optional. Filter by user id, and attach user data.	[optional]
inheritFromParent	Bool	Optional. Determines whether or not parent items should be searched for theme media.	[optional] [default to false]

Return type

ThemeMediaResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAddedMovies

    open class func postAddedMovies(tmdbId: String? = nil, imdbId: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let tmdbId = "tmdbId_example" // String | The tmdbId. (optional)
let imdbId = "imdbId_example" // String | The imdbId. (optional)

// Reports that new movies have been added by an external source.
LibraryAPI.postAddedMovies(tmdbId: tmdbId, imdbId: imdbId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
tmdbId	String	The tmdbId.	[optional]
imdbId	String	The imdbId.	[optional]

Return type

Void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postAddedSeries

    open class func postAddedSeries(tvdbId: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let tvdbId = "tvdbId_example" // String | The tvdbId. (optional)

// Reports that new episodes of a series have been added by an external source.
LibraryAPI.postAddedSeries(tvdbId: tvdbId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
tvdbId	String	The tvdbId.	[optional]

Return type

Void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postUpdatedMedia

    open class func postUpdatedMedia(mediaUpdateInfoDto: MediaUpdateInfoDto, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let mediaUpdateInfoDto = MediaUpdateInfoDto(updates: [MediaUpdateInfoPathDto(path: "path_example", updateType: "updateType_example")]) // MediaUpdateInfoDto | The update paths.

// Reports that new movies have been added by an external source.
LibraryAPI.postUpdatedMedia(mediaUpdateInfoDto: mediaUpdateInfoDto) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
mediaUpdateInfoDto	MediaUpdateInfoDto	The update paths.

Return type

Void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: application/json, text/json, application/_*+json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postUpdatedMovies

    open class func postUpdatedMovies(tmdbId: String? = nil, imdbId: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let tmdbId = "tmdbId_example" // String | The tmdbId. (optional)
let imdbId = "imdbId_example" // String | The imdbId. (optional)

// Reports that new movies have been added by an external source.
LibraryAPI.postUpdatedMovies(tmdbId: tmdbId, imdbId: imdbId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
tmdbId	String	The tmdbId.	[optional]
imdbId	String	The imdbId.	[optional]

Return type

Void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postUpdatedSeries

    open class func postUpdatedSeries(tvdbId: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let tvdbId = "tvdbId_example" // String | The tvdbId. (optional)

// Reports that new episodes of a series have been added by an external source.
LibraryAPI.postUpdatedSeries(tvdbId: tvdbId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
tvdbId	String	The tvdbId.	[optional]

Return type

Void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

refreshLibrary

    open class func refreshLibrary(completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Starts a library scan.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI


// Starts a library scan.
LibraryAPI.refreshLibrary() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]