jellyfin-sdk-swift/docs/StudiosAPI.md

StudiosAPI

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

Method	HTTP request	Description
getStudio	GET /Studios/{name}	Gets a studio by name.
getStudios	GET /Studios	Gets all studios from a given item, folder, or the entire library.

getStudio

    open class func getStudio(name: String, userId: String? = nil, completion: @escaping (_ data: BaseItemDto?, _ error: Error?) -> Void)

Gets a studio by name.

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 name = "name_example" // String | Studio name.
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)

// Gets a studio by name.
StudiosAPI.getStudio(name: name, userId: userId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
name	String	Studio name.
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]

getStudios

    open class func getStudios(startIndex: Int? = nil, limit: Int? = nil, searchTerm: String? = nil, parentId: String? = nil, fields: [ItemFields]? = nil, excludeItemTypes: [String]? = nil, includeItemTypes: [String]? = nil, isFavorite: Bool? = nil, enableUserData: Bool? = nil, imageTypeLimit: Int? = nil, enableImageTypes: [ImageType]? = nil, userId: String? = nil, nameStartsWithOrGreater: String? = nil, nameStartsWith: String? = nil, nameLessThan: String? = nil, enableImages: Bool? = nil, enableTotalRecordCount: Bool? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Gets all studios from a given item, folder, or the entire library.

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 startIndex = 987 // Int | Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let searchTerm = "searchTerm_example" // String | Optional. Search term. (optional)
let parentId = "parentId_example" // String | Specify this to localize the search to a specific item or folder. Omit to use the root. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. (optional)
let excludeItemTypes = ["inner_example"] // [String] | Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. (optional)
let includeItemTypes = ["inner_example"] // [String] | Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional)
let isFavorite = true // Bool | Optional filter by items that are marked as favorite, or not. (optional)
let enableUserData = true // Bool | Optional, include user data. (optional)
let imageTypeLimit = 987 // Int | Optional, the max number of images to return, per image type. (optional)
let enableImageTypes = [ImageType()] // [ImageType] | Optional. The image types to include in the output. (optional)
let userId = "userId_example" // String | User id. (optional)
let nameStartsWithOrGreater = "nameStartsWithOrGreater_example" // String | Optional filter by items whose name is sorted equally or greater than a given input string. (optional)
let nameStartsWith = "nameStartsWith_example" // String | Optional filter by items whose name is sorted equally than a given input string. (optional)
let nameLessThan = "nameLessThan_example" // String | Optional filter by items whose name is equally or lesser than a given input string. (optional)
let enableImages = true // Bool | Optional, include image information in output. (optional) (default to true)
let enableTotalRecordCount = true // Bool | Total record count. (optional) (default to true)

// Gets all studios from a given item, folder, or the entire library.
StudiosAPI.getStudios(startIndex: startIndex, limit: limit, searchTerm: searchTerm, parentId: parentId, fields: fields, excludeItemTypes: excludeItemTypes, includeItemTypes: includeItemTypes, isFavorite: isFavorite, enableUserData: enableUserData, imageTypeLimit: imageTypeLimit, enableImageTypes: enableImageTypes, userId: userId, nameStartsWithOrGreater: nameStartsWithOrGreater, nameStartsWith: nameStartsWith, nameLessThan: nameLessThan, enableImages: enableImages, enableTotalRecordCount: enableTotalRecordCount) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
startIndex	Int	Optional. The record index to start at. All items with a lower index will be dropped from the results.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
searchTerm	String	Optional. Search term.	[optional]
parentId	String	Specify this to localize the search to a specific item or folder. Omit to use the root.	[optional]
fields	**[ItemFields]**	Optional. Specify additional fields of information to return in the output.	[optional]
excludeItemTypes	**[String]**	Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.	[optional]
includeItemTypes	**[String]**	Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.	[optional]
isFavorite	Bool	Optional filter by items that are marked as favorite, or not.	[optional]
enableUserData	Bool	Optional, include user data.	[optional]
imageTypeLimit	Int	Optional, the max number of images to return, per image type.	[optional]
enableImageTypes	**[ImageType]**	Optional. The image types to include in the output.	[optional]
userId	String	User id.	[optional]
nameStartsWithOrGreater	String	Optional filter by items whose name is sorted equally or greater than a given input string.	[optional]
nameStartsWith	String	Optional filter by items whose name is sorted equally than a given input string.	[optional]
nameLessThan	String	Optional filter by items whose name is equally or lesser than a given input string.	[optional]
enableImages	Bool	Optional, include image information in output.	[optional] [default to true]
enableTotalRecordCount	Bool	Total record count.	[optional] [default to true]

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]