diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generate.sh b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generate.sh new file mode 100755 index 0000000000000..6482a3d5406ab --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generate.sh @@ -0,0 +1,47 @@ +#!/usr/bin/bash + +set -e + +VERSIONS=("10.8.13" "10.10.3") +REQUIRED=("wget" "yq" "openapi-generator-cli") + +function checkEnvironment() { + for i in "${REQUIRED[@]}"; do + if ! type $i &>/dev/null; then + echo "⚠️ [${i}] could not be found" + exit 127 + fi + done +} + +checkEnvironment + +for i in "${VERSIONS[@]}"; do + echo "ℹ️ - API Version to generate: $i" + + FILENAME_JSON="./specifications/json/jellyfin-openapi-${i}.json" + FILENAME_YAML="./specifications/yaml/jellyfin-openapi-${i}.yaml" + + if [ ! -e "${FILENAME_JSON}" ]; then + echo "⏬ - Downloading OPENAPI definition for Version ${i}" + + SERVER=https://repo.jellyfin.org/files/openapi/stable/jellyfin-openapi-${i}.json + + wget \ + --no-verbose \ + --output-document=${FILENAME_JSON} \ + ${SERVER} + + if [ ! -e "${FILENAME_YAML}" ]; then + echo "⚙️ - json ➡️ yaml" + yq -oy ${FILENAME_JSON} >${FILENAME_YAML} + fi + fi + + echo "⚙️ - generate code for API ${i}" + + # TODO: config.yaml - https://openapi-generator.tech/docs/customization + openapi-generator-cli generate -g java \ + --global-property models,modelTests=false,apis,apiTests=false,library=native,serializationLibrary=jackson,apiPackage=org.openhab.binding.jellyfin.internal.api.${i} \ + --input-spec ${FILENAME_YAML} -o ./generated/${i} 1>/dev/null +done diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/AccessSchedule.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AccessSchedule.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/AccessSchedule.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AccessSchedule.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogApi.md new file mode 100644 index 0000000000000..73da846d8d62a --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogApi.md @@ -0,0 +1,84 @@ +# ActivityLogApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getLogEntries**](ActivityLogApi.md#getLogEntries) | **GET** /System/ActivityLog/Entries | Gets activity log entries. | + + + +# **getLogEntries** +> ActivityLogEntryQueryResult getLogEntries(startIndex, limit, minDate, hasUserId) + +Gets activity log entries. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ActivityLogApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ActivityLogApi apiInstance = new ActivityLogApi(defaultClient); + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + OffsetDateTime minDate = OffsetDateTime.now(); // OffsetDateTime | Optional. The minimum date. Format = ISO. + Boolean hasUserId = true; // Boolean | Optional. Filter log entries if it has user id, or not. + try { + ActivityLogEntryQueryResult result = apiInstance.getLogEntries(startIndex, limit, minDate, hasUserId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ActivityLogApi#getLogEntries"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **minDate** | **OffsetDateTime**| Optional. The minimum date. Format = ISO. | [optional] | +| **hasUserId** | **Boolean**| Optional. Filter log entries if it has user id, or not. | [optional] | + +### Return type + +[**ActivityLogEntryQueryResult**](ActivityLogEntryQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Activity log returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ActivityLogEntry.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogEntry.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ActivityLogEntry.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogEntry.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogEntryMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogEntryMessage.md new file mode 100644 index 0000000000000..4ad25dc456d1a --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogEntryMessage.md @@ -0,0 +1,16 @@ + + +# ActivityLogEntryMessage + +Activity log created message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**List<ActivityLogEntry>**](ActivityLogEntry.md) | Gets or sets the data. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/ActivityLogEntryQueryResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogEntryQueryResult.md similarity index 95% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/ActivityLogEntryQueryResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogEntryQueryResult.md index c262fcb9f54f6..0de112353aca2 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/ActivityLogEntryQueryResult.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogEntryQueryResult.md @@ -2,6 +2,7 @@ # ActivityLogEntryQueryResult +Query result container. ## Properties diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogEntryStartMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogEntryStartMessage.md new file mode 100644 index 0000000000000..1985fa66ee602 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogEntryStartMessage.md @@ -0,0 +1,15 @@ + + +# ActivityLogEntryStartMessage + +Activity log entry start message. Data is the timing data encoded as \"$initialDelay,$interval\" in ms. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | **String** | Gets or sets the data. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogEntryStopMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogEntryStopMessage.md new file mode 100644 index 0000000000000..bdbdf25083d8c --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ActivityLogEntryStopMessage.md @@ -0,0 +1,14 @@ + + +# ActivityLogEntryStopMessage + +Activity log entry stop message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/AddVirtualFolderDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AddVirtualFolderDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/AddVirtualFolderDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AddVirtualFolderDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/AlbumInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AlbumInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/AlbumInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AlbumInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/AlbumInfoRemoteSearchQuery.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AlbumInfoRemoteSearchQuery.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/AlbumInfoRemoteSearchQuery.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AlbumInfoRemoteSearchQuery.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/AllThemeMediaResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AllThemeMediaResult.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/AllThemeMediaResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AllThemeMediaResult.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ApiKeyApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ApiKeyApi.md new file mode 100644 index 0000000000000..bfe184fdb2869 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ApiKeyApi.md @@ -0,0 +1,212 @@ +# ApiKeyApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**createKey**](ApiKeyApi.md#createKey) | **POST** /Auth/Keys | Create a new api key. | +| [**getKeys**](ApiKeyApi.md#getKeys) | **GET** /Auth/Keys | Get all keys. | +| [**revokeKey**](ApiKeyApi.md#revokeKey) | **DELETE** /Auth/Keys/{key} | Remove an api key. | + + + +# **createKey** +> createKey(app) + +Create a new api key. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ApiKeyApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ApiKeyApi apiInstance = new ApiKeyApi(defaultClient); + String app = "app_example"; // String | Name of the app using the authentication key. + try { + apiInstance.createKey(app); + } catch (ApiException e) { + System.err.println("Exception when calling ApiKeyApi#createKey"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **app** | **String**| Name of the app using the authentication key. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Api key created. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getKeys** +> AuthenticationInfoQueryResult getKeys() + +Get all keys. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ApiKeyApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ApiKeyApi apiInstance = new ApiKeyApi(defaultClient); + try { + AuthenticationInfoQueryResult result = apiInstance.getKeys(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ApiKeyApi#getKeys"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**AuthenticationInfoQueryResult**](AuthenticationInfoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Api keys retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **revokeKey** +> revokeKey(key) + +Remove an api key. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ApiKeyApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ApiKeyApi apiInstance = new ApiKeyApi(defaultClient); + String key = "key_example"; // String | The access token to delete. + try { + apiInstance.revokeKey(key); + } catch (ApiException e) { + System.err.println("Exception when calling ApiKeyApi#revokeKey"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **key** | **String**| The access token to delete. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Api key deleted. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ArtistInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ArtistInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ArtistInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ArtistInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ArtistInfoRemoteSearchQuery.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ArtistInfoRemoteSearchQuery.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ArtistInfoRemoteSearchQuery.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ArtistInfoRemoteSearchQuery.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ArtistsApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ArtistsApi.md new file mode 100644 index 0000000000000..a9a9ef8883a8e --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ArtistsApi.md @@ -0,0 +1,344 @@ +# ArtistsApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getAlbumArtists**](ArtistsApi.md#getAlbumArtists) | **GET** /Artists/AlbumArtists | Gets all album artists from a given item, folder, or the entire library. | +| [**getArtistByName**](ArtistsApi.md#getArtistByName) | **GET** /Artists/{name} | Gets an artist by name. | +| [**getArtists**](ArtistsApi.md#getArtists) | **GET** /Artists | Gets all artists from a given item, folder, or the entire library. | + + + +# **getAlbumArtists** +> BaseItemDtoQueryResult getAlbumArtists(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount) + +Gets all album artists from a given item, folder, or the entire library. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ArtistsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ArtistsApi apiInstance = new ArtistsApi(defaultClient); + Double minCommunityRating = 3.4D; // Double | Optional filter by minimum community rating. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + String searchTerm = "searchTerm_example"; // String | Optional. Search term. + UUID parentId = UUID.randomUUID(); // UUID | Specify this to localize the search to a specific item or folder. Omit to use the root. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + List excludeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. + List includeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. + List filters = Arrays.asList(); // List | Optional. Specify additional filters to apply. + Boolean isFavorite = true; // Boolean | Optional filter by items that are marked as favorite, or not. + List mediaTypes = Arrays.asList(); // List | Optional filter by MediaType. Allows multiple, comma delimited. + List genres = Arrays.asList(); // List | Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. + List genreIds = Arrays.asList(); // List | Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. + List officialRatings = Arrays.asList(); // List | Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. + List tags = Arrays.asList(); // List | Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. + List years = Arrays.asList(); // List | Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. + Boolean enableUserData = true; // Boolean | Optional, include user data. + Integer imageTypeLimit = 56; // Integer | Optional, the max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + String person = "person_example"; // String | Optional. If specified, results will be filtered to include only those containing the specified person. + List personIds = Arrays.asList(); // List | Optional. If specified, results will be filtered to include only those containing the specified person ids. + List personTypes = Arrays.asList(); // List | Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. + List studios = Arrays.asList(); // List | Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. + List studioIds = Arrays.asList(); // List | Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. + UUID userId = UUID.randomUUID(); // UUID | User id. + String nameStartsWithOrGreater = "nameStartsWithOrGreater_example"; // String | Optional filter by items whose name is sorted equally or greater than a given input string. + String nameStartsWith = "nameStartsWith_example"; // String | Optional filter by items whose name is sorted equally than a given input string. + String nameLessThan = "nameLessThan_example"; // String | Optional filter by items whose name is equally or lesser than a given input string. + List sortBy = Arrays.asList(); // List | Optional. Specify one or more sort orders, comma delimited. + List sortOrder = Arrays.asList(); // List | Sort Order - Ascending,Descending. + Boolean enableImages = true; // Boolean | Optional, include image information in output. + Boolean enableTotalRecordCount = true; // Boolean | Total record count. + try { + BaseItemDtoQueryResult result = apiInstance.getAlbumArtists(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ArtistsApi#getAlbumArtists"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **minCommunityRating** | **Double**| Optional filter by minimum community rating. | [optional] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **searchTerm** | **String**| Optional. Search term. | [optional] | +| **parentId** | **UUID**| Specify this to localize the search to a specific item or folder. Omit to use the root. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **excludeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. | [optional] | +| **includeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. | [optional] | +| **filters** | [**List<ItemFilter>**](ItemFilter.md)| Optional. Specify additional filters to apply. | [optional] | +| **isFavorite** | **Boolean**| Optional filter by items that are marked as favorite, or not. | [optional] | +| **mediaTypes** | [**List<MediaType>**](MediaType.md)| Optional filter by MediaType. Allows multiple, comma delimited. | [optional] | +| **genres** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. | [optional] | +| **genreIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. | [optional] | +| **officialRatings** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. | [optional] | +| **tags** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. | [optional] | +| **years** | [**List<Integer>**](Integer.md)| Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. | [optional] | +| **enableUserData** | **Boolean**| Optional, include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional, the max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **person** | **String**| Optional. If specified, results will be filtered to include only those containing the specified person. | [optional] | +| **personIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered to include only those containing the specified person ids. | [optional] | +| **personTypes** | [**List<String>**](String.md)| Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. | [optional] | +| **studios** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. | [optional] | +| **studioIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. | [optional] | +| **userId** | **UUID**| 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] | +| **sortBy** | [**List<ItemSortBy>**](ItemSortBy.md)| Optional. Specify one or more sort orders, comma delimited. | [optional] | +| **sortOrder** | [**List<SortOrder>**](SortOrder.md)| Sort Order - Ascending,Descending. | [optional] | +| **enableImages** | **Boolean**| Optional, include image information in output. | [optional] [default to true] | +| **enableTotalRecordCount** | **Boolean**| Total record count. | [optional] [default to true] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Album artists returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getArtistByName** +> BaseItemDto getArtistByName(name, userId) + +Gets an artist by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ArtistsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ArtistsApi apiInstance = new ArtistsApi(defaultClient); + String name = "name_example"; // String | Studio name. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + try { + BaseItemDto result = apiInstance.getArtistByName(name, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ArtistsApi#getArtistByName"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Studio name. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | + +### Return type + +[**BaseItemDto**](BaseItemDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Artist returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getArtists** +> BaseItemDtoQueryResult getArtists(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount) + +Gets all artists from a given item, folder, or the entire library. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ArtistsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ArtistsApi apiInstance = new ArtistsApi(defaultClient); + Double minCommunityRating = 3.4D; // Double | Optional filter by minimum community rating. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + String searchTerm = "searchTerm_example"; // String | Optional. Search term. + UUID parentId = UUID.randomUUID(); // UUID | Specify this to localize the search to a specific item or folder. Omit to use the root. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + List excludeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. + List includeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. + List filters = Arrays.asList(); // List | Optional. Specify additional filters to apply. + Boolean isFavorite = true; // Boolean | Optional filter by items that are marked as favorite, or not. + List mediaTypes = Arrays.asList(); // List | Optional filter by MediaType. Allows multiple, comma delimited. + List genres = Arrays.asList(); // List | Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. + List genreIds = Arrays.asList(); // List | Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. + List officialRatings = Arrays.asList(); // List | Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. + List tags = Arrays.asList(); // List | Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. + List years = Arrays.asList(); // List | Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. + Boolean enableUserData = true; // Boolean | Optional, include user data. + Integer imageTypeLimit = 56; // Integer | Optional, the max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + String person = "person_example"; // String | Optional. If specified, results will be filtered to include only those containing the specified person. + List personIds = Arrays.asList(); // List | Optional. If specified, results will be filtered to include only those containing the specified person ids. + List personTypes = Arrays.asList(); // List | Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. + List studios = Arrays.asList(); // List | Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. + List studioIds = Arrays.asList(); // List | Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. + UUID userId = UUID.randomUUID(); // UUID | User id. + String nameStartsWithOrGreater = "nameStartsWithOrGreater_example"; // String | Optional filter by items whose name is sorted equally or greater than a given input string. + String nameStartsWith = "nameStartsWith_example"; // String | Optional filter by items whose name is sorted equally than a given input string. + String nameLessThan = "nameLessThan_example"; // String | Optional filter by items whose name is equally or lesser than a given input string. + List sortBy = Arrays.asList(); // List | Optional. Specify one or more sort orders, comma delimited. + List sortOrder = Arrays.asList(); // List | Sort Order - Ascending,Descending. + Boolean enableImages = true; // Boolean | Optional, include image information in output. + Boolean enableTotalRecordCount = true; // Boolean | Total record count. + try { + BaseItemDtoQueryResult result = apiInstance.getArtists(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ArtistsApi#getArtists"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **minCommunityRating** | **Double**| Optional filter by minimum community rating. | [optional] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **searchTerm** | **String**| Optional. Search term. | [optional] | +| **parentId** | **UUID**| Specify this to localize the search to a specific item or folder. Omit to use the root. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **excludeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. | [optional] | +| **includeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. | [optional] | +| **filters** | [**List<ItemFilter>**](ItemFilter.md)| Optional. Specify additional filters to apply. | [optional] | +| **isFavorite** | **Boolean**| Optional filter by items that are marked as favorite, or not. | [optional] | +| **mediaTypes** | [**List<MediaType>**](MediaType.md)| Optional filter by MediaType. Allows multiple, comma delimited. | [optional] | +| **genres** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. | [optional] | +| **genreIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. | [optional] | +| **officialRatings** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. | [optional] | +| **tags** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. | [optional] | +| **years** | [**List<Integer>**](Integer.md)| Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. | [optional] | +| **enableUserData** | **Boolean**| Optional, include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional, the max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **person** | **String**| Optional. If specified, results will be filtered to include only those containing the specified person. | [optional] | +| **personIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered to include only those containing the specified person ids. | [optional] | +| **personTypes** | [**List<String>**](String.md)| Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. | [optional] | +| **studios** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. | [optional] | +| **studioIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. | [optional] | +| **userId** | **UUID**| 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] | +| **sortBy** | [**List<ItemSortBy>**](ItemSortBy.md)| Optional. Specify one or more sort orders, comma delimited. | [optional] | +| **sortOrder** | [**List<SortOrder>**](SortOrder.md)| Sort Order - Ascending,Descending. | [optional] | +| **enableImages** | **Boolean**| Optional, include image information in output. | [optional] [default to true] | +| **enableTotalRecordCount** | **Boolean**| Total record count. | [optional] [default to true] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Artists returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AudioApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AudioApi.md new file mode 100644 index 0000000000000..ac65b12e2ed34 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AudioApi.md @@ -0,0 +1,644 @@ +# AudioApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getAudioStream**](AudioApi.md#getAudioStream) | **GET** /Audio/{itemId}/stream | Gets an audio stream. | +| [**getAudioStreamByContainer**](AudioApi.md#getAudioStreamByContainer) | **GET** /Audio/{itemId}/stream.{container} | Gets an audio stream. | +| [**headAudioStream**](AudioApi.md#headAudioStream) | **HEAD** /Audio/{itemId}/stream | Gets an audio stream. | +| [**headAudioStreamByContainer**](AudioApi.md#headAudioStreamByContainer) | **HEAD** /Audio/{itemId}/stream.{container} | Gets an audio stream. | + + + +# **getAudioStream** +> File getAudioStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding) + +Gets an audio stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.AudioApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + AudioApi apiInstance = new AudioApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String container = "container_example"; // String | The audio container. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamorphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + try { + File result = apiInstance.getAudioStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AudioApi#getAudioStream"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **container** | **String**| The audio container. | [optional] | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamorphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: audio/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Audio stream returned. | - | + + +# **getAudioStreamByContainer** +> File getAudioStreamByContainer(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding) + +Gets an audio stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.AudioApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + AudioApi apiInstance = new AudioApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String container = "container_example"; // String | The audio container. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamporphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + try { + File result = apiInstance.getAudioStreamByContainer(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AudioApi#getAudioStreamByContainer"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **container** | **String**| The audio container. | | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamporphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: audio/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Audio stream returned. | - | + + +# **headAudioStream** +> File headAudioStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding) + +Gets an audio stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.AudioApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + AudioApi apiInstance = new AudioApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String container = "container_example"; // String | The audio container. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamorphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + try { + File result = apiInstance.headAudioStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AudioApi#headAudioStream"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **container** | **String**| The audio container. | [optional] | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamorphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: audio/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Audio stream returned. | - | + + +# **headAudioStreamByContainer** +> File headAudioStreamByContainer(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding) + +Gets an audio stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.AudioApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + AudioApi apiInstance = new AudioApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String container = "container_example"; // String | The audio container. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamporphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + try { + File result = apiInstance.headAudioStreamByContainer(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AudioApi#headAudioStreamByContainer"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **container** | **String**| The audio container. | | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamporphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: audio/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Audio stream returned. | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AudioSpatialFormat.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AudioSpatialFormat.md new file mode 100644 index 0000000000000..49fa2aaed42be --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AudioSpatialFormat.md @@ -0,0 +1,15 @@ + + +# AudioSpatialFormat + +## Enum + + +* `NONE` (value: `"None"`) + +* `DOLBY_ATMOS` (value: `"DolbyAtmos"`) + +* `DTSX` (value: `"DTSX"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/AuthenticateUserByName.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AuthenticateUserByName.md similarity index 80% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/AuthenticateUserByName.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AuthenticateUserByName.md index f76ef387c7270..701c5cedbd79d 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/AuthenticateUserByName.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AuthenticateUserByName.md @@ -10,7 +10,6 @@ The authenticate user by name request body. |------------ | ------------- | ------------- | -------------| |**username** | **String** | Gets or sets the username. | [optional] | |**pw** | **String** | Gets or sets the plain text password. | [optional] | -|**password** | **String** | Gets or sets the sha1-hashed password. | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/AuthenticationInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AuthenticationInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/AuthenticationInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AuthenticationInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/AuthenticationInfoQueryResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AuthenticationInfoQueryResult.md similarity index 95% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/AuthenticationInfoQueryResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AuthenticationInfoQueryResult.md index cc5058d2c6280..e72217f1446b5 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/AuthenticationInfoQueryResult.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AuthenticationInfoQueryResult.md @@ -2,6 +2,7 @@ # AuthenticationInfoQueryResult +Query result container. ## Properties diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AuthenticationResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AuthenticationResult.md new file mode 100644 index 0000000000000..b5504f0109954 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/AuthenticationResult.md @@ -0,0 +1,17 @@ + + +# AuthenticationResult + +A class representing an authentication result. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**user** | [**UserDto**](UserDto.md) | Class UserDto. | [optional] | +|**sessionInfo** | [**SessionInfoDto**](SessionInfoDto.md) | Session info DTO. | [optional] | +|**accessToken** | **String** | Gets or sets the access token. | [optional] | +|**serverId** | **String** | Gets or sets the server id. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/BaseItemDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BaseItemDto.md similarity index 92% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/BaseItemDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BaseItemDto.md index c4a3294e0416e..d71761ea5e6ca 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/BaseItemDto.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BaseItemDto.md @@ -17,16 +17,16 @@ This is strictly used as a data transfer object from the api layer. This holds |**playlistItemId** | **String** | Gets or sets the playlist item identifier. | [optional] | |**dateCreated** | **OffsetDateTime** | Gets or sets the date created. | [optional] | |**dateLastMediaAdded** | **OffsetDateTime** | | [optional] | -|**extraType** | **String** | | [optional] | +|**extraType** | **ExtraType** | | [optional] | |**airsBeforeSeasonNumber** | **Integer** | | [optional] | |**airsAfterSeasonNumber** | **Integer** | | [optional] | |**airsBeforeEpisodeNumber** | **Integer** | | [optional] | |**canDelete** | **Boolean** | | [optional] | |**canDownload** | **Boolean** | | [optional] | +|**hasLyrics** | **Boolean** | | [optional] | |**hasSubtitles** | **Boolean** | | [optional] | |**preferredMetadataLanguage** | **String** | | [optional] | |**preferredMetadataCountryCode** | **String** | | [optional] | -|**supportsSync** | **Boolean** | Gets or sets a value indicating whether [supports synchronize]. | [optional] | |**container** | **String** | | [optional] | |**sortName** | **String** | Gets or sets the name of the sort. | [optional] | |**forcedSortName** | **String** | | [optional] | @@ -62,12 +62,12 @@ This is strictly used as a data transfer object from the api layer. This holds |**isHD** | **Boolean** | Gets or sets a value indicating whether this instance is HD. | [optional] | |**isFolder** | **Boolean** | Gets or sets a value indicating whether this instance is folder. | [optional] | |**parentId** | **UUID** | Gets or sets the parent id. | [optional] | -|**type** | **BaseItemKind** | Gets or sets the type. | [optional] | +|**type** | **BaseItemKind** | The base item kind. | [optional] | |**people** | [**List<BaseItemPerson>**](BaseItemPerson.md) | Gets or sets the people. | [optional] | |**studios** | [**List<NameGuidPair>**](NameGuidPair.md) | Gets or sets the studios. | [optional] | |**genreItems** | [**List<NameGuidPair>**](NameGuidPair.md) | | [optional] | -|**parentLogoItemId** | **UUID** | Gets or sets wether the item has a logo, this will hold the Id of the Parent that has one. | [optional] | -|**parentBackdropItemId** | **UUID** | Gets or sets wether the item has any backdrops, this will hold the Id of the Parent that has one. | [optional] | +|**parentLogoItemId** | **UUID** | Gets or sets whether the item has a logo, this will hold the Id of the Parent that has one. | [optional] | +|**parentBackdropItemId** | **UUID** | Gets or sets whether the item has any backdrops, this will hold the Id of the Parent that has one. | [optional] | |**parentBackdropImageTags** | **List<String>** | Gets or sets the parent backdrop image tags. | [optional] | |**localTrailerCount** | **Integer** | Gets or sets the local trailer count. | [optional] | |**userData** | [**UserItemDataDto**](UserItemDataDto.md) | Gets or sets the user data for this item based on the user it's being requested for. | [optional] | @@ -86,7 +86,7 @@ This is strictly used as a data transfer object from the api layer. This holds |**artists** | **List<String>** | Gets or sets the artists. | [optional] | |**artistItems** | [**List<NameGuidPair>**](NameGuidPair.md) | Gets or sets the artist items. | [optional] | |**album** | **String** | Gets or sets the album. | [optional] | -|**collectionType** | **String** | Gets or sets the type of the collection. | [optional] | +|**collectionType** | **CollectionType** | Gets or sets the type of the collection. | [optional] | |**displayOrder** | **String** | Gets or sets the display order. | [optional] | |**albumId** | **UUID** | Gets or sets the album id. | [optional] | |**albumPrimaryImageTag** | **String** | Gets or sets the album image tag. | [optional] | @@ -102,7 +102,7 @@ This is strictly used as a data transfer object from the api layer. This holds |**backdropImageTags** | **List<String>** | Gets or sets the backdrop image tags. | [optional] | |**screenshotImageTags** | **List<String>** | Gets or sets the screenshot image tags. | [optional] | |**parentLogoImageTag** | **String** | Gets or sets the parent logo image tag. | [optional] | -|**parentArtItemId** | **UUID** | Gets or sets wether the item has fan art, this will hold the Id of the Parent that has one. | [optional] | +|**parentArtItemId** | **UUID** | Gets or sets whether the item has fan art, this will hold the Id of the Parent that has one. | [optional] | |**parentArtImageTag** | **String** | Gets or sets the parent art image tag. | [optional] | |**seriesThumbImageTag** | **String** | Gets or sets the series thumb image tag. | [optional] | |**imageBlurHashes** | [**BaseItemDtoImageBlurHashes**](BaseItemDtoImageBlurHashes.md) | | [optional] | @@ -112,9 +112,10 @@ This is strictly used as a data transfer object from the api layer. This holds |**parentPrimaryImageItemId** | **String** | Gets or sets the parent primary image item identifier. | [optional] | |**parentPrimaryImageTag** | **String** | Gets or sets the parent primary image tag. | [optional] | |**chapters** | [**List<ChapterInfo>**](ChapterInfo.md) | Gets or sets the chapters. | [optional] | +|**trickplay** | **Map<String, Map<String, TrickplayInfo>>** | Gets or sets the trickplay manifest. | [optional] | |**locationType** | **LocationType** | Gets or sets the type of the location. | [optional] | |**isoType** | **IsoType** | Gets or sets the type of the iso. | [optional] | -|**mediaType** | **String** | Gets or sets the type of the media. | [optional] | +|**mediaType** | **MediaType** | Media types. | [optional] | |**endDate** | **OffsetDateTime** | Gets or sets the end date. | [optional] | |**lockedFields** | **List<MetadataField>** | Gets or sets the locked fields. | [optional] | |**trailerCount** | **Integer** | Gets or sets the trailer count. | [optional] | @@ -158,6 +159,7 @@ This is strictly used as a data transfer object from the api layer. This holds |**isKids** | **Boolean** | Gets or sets a value indicating whether this instance is kids. | [optional] | |**isPremiere** | **Boolean** | Gets or sets a value indicating whether this instance is premiere. | [optional] | |**timerId** | **String** | Gets or sets the timer identifier. | [optional] | +|**normalizationGain** | **Float** | Gets or sets the gain required for audio normalization. | [optional] | |**currentProgram** | [**BaseItemDto**](BaseItemDto.md) | Gets or sets the current program. | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BaseItemDtoImageBlurHashes.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BaseItemDtoImageBlurHashes.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BaseItemDtoImageBlurHashes.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BaseItemDtoImageBlurHashes.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/BaseItemDtoQueryResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BaseItemDtoQueryResult.md similarity index 95% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/BaseItemDtoQueryResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BaseItemDtoQueryResult.md index cddef1833761d..05a805012f77e 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/BaseItemDtoQueryResult.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BaseItemDtoQueryResult.md @@ -2,6 +2,7 @@ # BaseItemDtoQueryResult +Query result container. ## Properties diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BaseItemKind.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BaseItemKind.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BaseItemKind.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BaseItemKind.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/BaseItemPerson.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BaseItemPerson.md similarity index 90% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/BaseItemPerson.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BaseItemPerson.md index 108a7141ac7a9..a5946f50d5731 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/BaseItemPerson.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BaseItemPerson.md @@ -11,7 +11,7 @@ This is used by the api to get information about a Person within a BaseItem. |**name** | **String** | Gets or sets the name. | [optional] | |**id** | **UUID** | Gets or sets the identifier. | [optional] | |**role** | **String** | Gets or sets the role. | [optional] | -|**type** | **String** | Gets or sets the type. | [optional] | +|**type** | **PersonKind** | The person kind. | [optional] | |**primaryImageTag** | **String** | Gets or sets the primary image tag. | [optional] | |**imageBlurHashes** | [**BaseItemPersonImageBlurHashes**](BaseItemPersonImageBlurHashes.md) | | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BaseItemPersonImageBlurHashes.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BaseItemPersonImageBlurHashes.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BaseItemPersonImageBlurHashes.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BaseItemPersonImageBlurHashes.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BookInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BookInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BookInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BookInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BookInfoRemoteSearchQuery.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BookInfoRemoteSearchQuery.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BookInfoRemoteSearchQuery.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BookInfoRemoteSearchQuery.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BoxSetInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BoxSetInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BoxSetInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BoxSetInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BoxSetInfoRemoteSearchQuery.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BoxSetInfoRemoteSearchQuery.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BoxSetInfoRemoteSearchQuery.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BoxSetInfoRemoteSearchQuery.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BrandingApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BrandingApi.md new file mode 100644 index 0000000000000..056019cee52a0 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BrandingApi.md @@ -0,0 +1,181 @@ +# BrandingApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getBrandingCss**](BrandingApi.md#getBrandingCss) | **GET** /Branding/Css | Gets branding css. | +| [**getBrandingCss2**](BrandingApi.md#getBrandingCss2) | **GET** /Branding/Css.css | Gets branding css. | +| [**getBrandingOptions**](BrandingApi.md#getBrandingOptions) | **GET** /Branding/Configuration | Gets branding configuration. | + + + +# **getBrandingCss** +> String getBrandingCss() + +Gets branding css. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.BrandingApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + BrandingApi apiInstance = new BrandingApi(defaultClient); + try { + String result = apiInstance.getBrandingCss(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling BrandingApi#getBrandingCss"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/css, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Branding css returned. | - | +| **204** | No branding css configured. | - | + + +# **getBrandingCss2** +> String getBrandingCss2() + +Gets branding css. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.BrandingApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + BrandingApi apiInstance = new BrandingApi(defaultClient); + try { + String result = apiInstance.getBrandingCss2(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling BrandingApi#getBrandingCss2"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/css, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Branding css returned. | - | +| **204** | No branding css configured. | - | + + +# **getBrandingOptions** +> BrandingOptions getBrandingOptions() + +Gets branding configuration. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.BrandingApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + BrandingApi apiInstance = new BrandingApi(defaultClient); + try { + BrandingOptions result = apiInstance.getBrandingOptions(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling BrandingApi#getBrandingOptions"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**BrandingOptions**](BrandingOptions.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Branding configuration returned. | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BrandingOptions.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BrandingOptions.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BrandingOptions.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BrandingOptions.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BufferRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BufferRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/BufferRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/BufferRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CastReceiverApplication.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CastReceiverApplication.md new file mode 100644 index 0000000000000..ad6f7241e0603 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CastReceiverApplication.md @@ -0,0 +1,15 @@ + + +# CastReceiverApplication + +The cast receiver application model. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**id** | **String** | Gets or sets the cast receiver application id. | [optional] | +|**name** | **String** | Gets or sets the cast receiver application name. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ChannelFeatures.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChannelFeatures.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ChannelFeatures.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChannelFeatures.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ChannelItemSortField.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChannelItemSortField.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ChannelItemSortField.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChannelItemSortField.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ChannelMappingOptionsDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChannelMappingOptionsDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ChannelMappingOptionsDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChannelMappingOptionsDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ChannelMediaContentType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChannelMediaContentType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ChannelMediaContentType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChannelMediaContentType.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ChannelMediaType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChannelMediaType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ChannelMediaType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChannelMediaType.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ChannelType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChannelType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ChannelType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChannelType.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChannelsApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChannelsApi.md new file mode 100644 index 0000000000000..b7e822a895d5f --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChannelsApi.md @@ -0,0 +1,390 @@ +# ChannelsApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getAllChannelFeatures**](ChannelsApi.md#getAllChannelFeatures) | **GET** /Channels/Features | Get all channel features. | +| [**getChannelFeatures**](ChannelsApi.md#getChannelFeatures) | **GET** /Channels/{channelId}/Features | Get channel features. | +| [**getChannelItems**](ChannelsApi.md#getChannelItems) | **GET** /Channels/{channelId}/Items | Get channel items. | +| [**getChannels**](ChannelsApi.md#getChannels) | **GET** /Channels | Gets available channels. | +| [**getLatestChannelItems**](ChannelsApi.md#getLatestChannelItems) | **GET** /Channels/Items/Latest | Gets latest channel items. | + + + +# **getAllChannelFeatures** +> List<ChannelFeatures> getAllChannelFeatures() + +Get all channel features. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ChannelsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ChannelsApi apiInstance = new ChannelsApi(defaultClient); + try { + List result = apiInstance.getAllChannelFeatures(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ChannelsApi#getAllChannelFeatures"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<ChannelFeatures>**](ChannelFeatures.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | All channel features returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getChannelFeatures** +> ChannelFeatures getChannelFeatures(channelId) + +Get channel features. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ChannelsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ChannelsApi apiInstance = new ChannelsApi(defaultClient); + UUID channelId = UUID.randomUUID(); // UUID | Channel id. + try { + ChannelFeatures result = apiInstance.getChannelFeatures(channelId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ChannelsApi#getChannelFeatures"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **channelId** | **UUID**| Channel id. | | + +### Return type + +[**ChannelFeatures**](ChannelFeatures.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Channel features returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getChannelItems** +> BaseItemDtoQueryResult getChannelItems(channelId, folderId, userId, startIndex, limit, sortOrder, filters, sortBy, fields) + +Get channel items. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ChannelsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ChannelsApi apiInstance = new ChannelsApi(defaultClient); + UUID channelId = UUID.randomUUID(); // UUID | Channel Id. + UUID folderId = UUID.randomUUID(); // UUID | Optional. Folder Id. + UUID userId = UUID.randomUUID(); // UUID | Optional. User Id. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List sortOrder = Arrays.asList(); // List | Optional. Sort Order - Ascending,Descending. + List filters = Arrays.asList(); // List | Optional. Specify additional filters to apply. + List sortBy = Arrays.asList(); // List | Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + try { + BaseItemDtoQueryResult result = apiInstance.getChannelItems(channelId, folderId, userId, startIndex, limit, sortOrder, filters, sortBy, fields); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ChannelsApi#getChannelItems"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **channelId** | **UUID**| Channel Id. | | +| **folderId** | **UUID**| Optional. Folder Id. | [optional] | +| **userId** | **UUID**| Optional. User Id. | [optional] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **sortOrder** | [**List<SortOrder>**](SortOrder.md)| Optional. Sort Order - Ascending,Descending. | [optional] | +| **filters** | [**List<ItemFilter>**](ItemFilter.md)| Optional. Specify additional filters to apply. | [optional] | +| **sortBy** | [**List<ItemSortBy>**](ItemSortBy.md)| Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Channel items returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getChannels** +> BaseItemDtoQueryResult getChannels(userId, startIndex, limit, supportsLatestItems, supportsMediaDeletion, isFavorite) + +Gets available channels. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ChannelsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ChannelsApi apiInstance = new ChannelsApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | User Id to filter by. Use System.Guid.Empty to not filter by user. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + Boolean supportsLatestItems = true; // Boolean | Optional. Filter by channels that support getting latest items. + Boolean supportsMediaDeletion = true; // Boolean | Optional. Filter by channels that support media deletion. + Boolean isFavorite = true; // Boolean | Optional. Filter by channels that are favorite. + try { + BaseItemDtoQueryResult result = apiInstance.getChannels(userId, startIndex, limit, supportsLatestItems, supportsMediaDeletion, isFavorite); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ChannelsApi#getChannels"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| User Id to filter by. Use System.Guid.Empty to not filter by user. | [optional] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **supportsLatestItems** | **Boolean**| Optional. Filter by channels that support getting latest items. | [optional] | +| **supportsMediaDeletion** | **Boolean**| Optional. Filter by channels that support media deletion. | [optional] | +| **isFavorite** | **Boolean**| Optional. Filter by channels that are favorite. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Channels returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getLatestChannelItems** +> BaseItemDtoQueryResult getLatestChannelItems(userId, startIndex, limit, filters, fields, channelIds) + +Gets latest channel items. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ChannelsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ChannelsApi apiInstance = new ChannelsApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | Optional. User Id. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List filters = Arrays.asList(); // List | Optional. Specify additional filters to apply. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + List channelIds = Arrays.asList(); // List | Optional. Specify one or more channel id's, comma delimited. + try { + BaseItemDtoQueryResult result = apiInstance.getLatestChannelItems(userId, startIndex, limit, filters, fields, channelIds); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ChannelsApi#getLatestChannelItems"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| Optional. User Id. | [optional] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **filters** | [**List<ItemFilter>**](ItemFilter.md)| Optional. Specify additional filters to apply. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **channelIds** | [**List<UUID>**](UUID.md)| Optional. Specify one or more channel id's, comma delimited. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Latest channel items returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ChapterInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChapterInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ChapterInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ChapterInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ClientCapabilitiesDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ClientCapabilitiesDto.md new file mode 100644 index 0000000000000..aad82dd9eddc6 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ClientCapabilitiesDto.md @@ -0,0 +1,20 @@ + + +# ClientCapabilitiesDto + +Client capabilities dto. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**playableMediaTypes** | **List<MediaType>** | Gets or sets the list of playable media types. | [optional] | +|**supportedCommands** | **List<GeneralCommandType>** | Gets or sets the list of supported commands. | [optional] | +|**supportsMediaControl** | **Boolean** | Gets or sets a value indicating whether session supports media control. | [optional] | +|**supportsPersistentIdentifier** | **Boolean** | Gets or sets a value indicating whether session supports a persistent identifier. | [optional] | +|**deviceProfile** | [**DeviceProfile**](DeviceProfile.md) | Gets or sets the device profile. | [optional] | +|**appStoreUrl** | **String** | Gets or sets the app store url. | [optional] | +|**iconUrl** | **String** | Gets or sets the icon url. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ClientLogApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ClientLogApi.md new file mode 100644 index 0000000000000..f87e3f25bd03e --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ClientLogApi.md @@ -0,0 +1,79 @@ +# ClientLogApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**logFile**](ClientLogApi.md#logFile) | **POST** /ClientLog/Document | Upload a document. | + + + +# **logFile** +> ClientLogDocumentResponseDto logFile(body) + +Upload a document. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ClientLogApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ClientLogApi apiInstance = new ClientLogApi(defaultClient); + File body = new File("/path/to/file"); // File | + try { + ClientLogDocumentResponseDto result = apiInstance.logFile(body); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ClientLogApi#logFile"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **body** | **File**| | [optional] | + +### Return type + +[**ClientLogDocumentResponseDto**](ClientLogDocumentResponseDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: text/plain + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Document saved. | - | +| **403** | Event logging disabled. | - | +| **413** | Upload size too large. | - | +| **401** | Unauthorized | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ClientLogDocumentResponseDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ClientLogDocumentResponseDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ClientLogDocumentResponseDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ClientLogDocumentResponseDto.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CodecProfile.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CodecProfile.md new file mode 100644 index 0000000000000..9481eecc1806f --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CodecProfile.md @@ -0,0 +1,19 @@ + + +# CodecProfile + +Defines the MediaBrowser.Model.Dlna.CodecProfile. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**type** | **CodecType** | Gets or sets the MediaBrowser.Model.Dlna.CodecType which this container must meet. | [optional] | +|**conditions** | [**List<ProfileCondition>**](ProfileCondition.md) | Gets or sets the list of MediaBrowser.Model.Dlna.ProfileCondition which this profile must meet. | [optional] | +|**applyConditions** | [**List<ProfileCondition>**](ProfileCondition.md) | Gets or sets the list of MediaBrowser.Model.Dlna.ProfileCondition to apply if this profile is met. | [optional] | +|**codec** | **String** | Gets or sets the codec(s) that this profile applies to. | [optional] | +|**container** | **String** | Gets or sets the container(s) which this profile will be applied to. | [optional] | +|**subContainer** | **String** | Gets or sets the sub-container(s) which this profile will be applied to. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/CodecType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CodecType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/CodecType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CodecType.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CollectionApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CollectionApi.md new file mode 100644 index 0000000000000..17c33a70bf280 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CollectionApi.md @@ -0,0 +1,226 @@ +# CollectionApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**addToCollection**](CollectionApi.md#addToCollection) | **POST** /Collections/{collectionId}/Items | Adds items to a collection. | +| [**createCollection**](CollectionApi.md#createCollection) | **POST** /Collections | Creates a new collection. | +| [**removeFromCollection**](CollectionApi.md#removeFromCollection) | **DELETE** /Collections/{collectionId}/Items | Removes items from a collection. | + + + +# **addToCollection** +> addToCollection(collectionId, ids) + +Adds items to a collection. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.CollectionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + CollectionApi apiInstance = new CollectionApi(defaultClient); + UUID collectionId = UUID.randomUUID(); // UUID | The collection id. + List ids = Arrays.asList(); // List | Item ids, comma delimited. + try { + apiInstance.addToCollection(collectionId, ids); + } catch (ApiException e) { + System.err.println("Exception when calling CollectionApi#addToCollection"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **collectionId** | **UUID**| The collection id. | | +| **ids** | [**List<UUID>**](UUID.md)| Item ids, comma delimited. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Items added to collection. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **createCollection** +> CollectionCreationResult createCollection(name, ids, parentId, isLocked) + +Creates a new collection. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.CollectionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + CollectionApi apiInstance = new CollectionApi(defaultClient); + String name = "name_example"; // String | The name of the collection. + List ids = Arrays.asList(); // List | Item Ids to add to the collection. + UUID parentId = UUID.randomUUID(); // UUID | Optional. Create the collection within a specific folder. + Boolean isLocked = false; // Boolean | Whether or not to lock the new collection. + try { + CollectionCreationResult result = apiInstance.createCollection(name, ids, parentId, isLocked); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling CollectionApi#createCollection"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| The name of the collection. | [optional] | +| **ids** | [**List<String>**](String.md)| Item Ids to add to the collection. | [optional] | +| **parentId** | **UUID**| Optional. Create the collection within a specific folder. | [optional] | +| **isLocked** | **Boolean**| Whether or not to lock the new collection. | [optional] [default to false] | + +### Return type + +[**CollectionCreationResult**](CollectionCreationResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Collection created. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **removeFromCollection** +> removeFromCollection(collectionId, ids) + +Removes items from a collection. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.CollectionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + CollectionApi apiInstance = new CollectionApi(defaultClient); + UUID collectionId = UUID.randomUUID(); // UUID | The collection id. + List ids = Arrays.asList(); // List | Item ids, comma delimited. + try { + apiInstance.removeFromCollection(collectionId, ids); + } catch (ApiException e) { + System.err.println("Exception when calling CollectionApi#removeFromCollection"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **collectionId** | **UUID**| The collection id. | | +| **ids** | [**List<UUID>**](UUID.md)| Item ids, comma delimited. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Items removed from collection. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/CollectionCreationResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CollectionCreationResult.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/CollectionCreationResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CollectionCreationResult.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CollectionType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CollectionType.md new file mode 100644 index 0000000000000..c987c1c8bbdc0 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CollectionType.md @@ -0,0 +1,35 @@ + + +# CollectionType + +## Enum + + +* `UNKNOWN` (value: `"unknown"`) + +* `MOVIES` (value: `"movies"`) + +* `TVSHOWS` (value: `"tvshows"`) + +* `MUSIC` (value: `"music"`) + +* `MUSICVIDEOS` (value: `"musicvideos"`) + +* `TRAILERS` (value: `"trailers"`) + +* `HOMEVIDEOS` (value: `"homevideos"`) + +* `BOXSETS` (value: `"boxsets"`) + +* `BOOKS` (value: `"books"`) + +* `PHOTOS` (value: `"photos"`) + +* `LIVETV` (value: `"livetv"`) + +* `PLAYLISTS` (value: `"playlists"`) + +* `FOLDERS` (value: `"folders"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CollectionTypeOptions.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CollectionTypeOptions.md new file mode 100644 index 0000000000000..92b27769c5fc4 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CollectionTypeOptions.md @@ -0,0 +1,25 @@ + + +# CollectionTypeOptions + +## Enum + + +* `MOVIES` (value: `"movies"`) + +* `TVSHOWS` (value: `"tvshows"`) + +* `MUSIC` (value: `"music"`) + +* `MUSICVIDEOS` (value: `"musicvideos"`) + +* `HOMEVIDEOS` (value: `"homevideos"`) + +* `BOXSETS` (value: `"boxsets"`) + +* `BOOKS` (value: `"books"`) + +* `MIXED` (value: `"mixed"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ConfigImageTypes.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ConfigImageTypes.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ConfigImageTypes.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ConfigImageTypes.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ConfigurationApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ConfigurationApi.md new file mode 100644 index 0000000000000..5c5bc7f4d7fd0 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ConfigurationApi.md @@ -0,0 +1,350 @@ +# ConfigurationApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getConfiguration**](ConfigurationApi.md#getConfiguration) | **GET** /System/Configuration | Gets application configuration. | +| [**getDefaultMetadataOptions**](ConfigurationApi.md#getDefaultMetadataOptions) | **GET** /System/Configuration/MetadataOptions/Default | Gets a default MetadataOptions object. | +| [**getNamedConfiguration**](ConfigurationApi.md#getNamedConfiguration) | **GET** /System/Configuration/{key} | Gets a named configuration. | +| [**updateConfiguration**](ConfigurationApi.md#updateConfiguration) | **POST** /System/Configuration | Updates application configuration. | +| [**updateNamedConfiguration**](ConfigurationApi.md#updateNamedConfiguration) | **POST** /System/Configuration/{key} | Updates named configuration. | + + + +# **getConfiguration** +> ServerConfiguration getConfiguration() + +Gets application configuration. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ConfigurationApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ConfigurationApi apiInstance = new ConfigurationApi(defaultClient); + try { + ServerConfiguration result = apiInstance.getConfiguration(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ConfigurationApi#getConfiguration"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ServerConfiguration**](ServerConfiguration.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Application configuration returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getDefaultMetadataOptions** +> MetadataOptions getDefaultMetadataOptions() + +Gets a default MetadataOptions object. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ConfigurationApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ConfigurationApi apiInstance = new ConfigurationApi(defaultClient); + try { + MetadataOptions result = apiInstance.getDefaultMetadataOptions(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ConfigurationApi#getDefaultMetadataOptions"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**MetadataOptions**](MetadataOptions.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Metadata options returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getNamedConfiguration** +> File getNamedConfiguration(key) + +Gets a named configuration. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ConfigurationApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ConfigurationApi apiInstance = new ConfigurationApi(defaultClient); + String key = "key_example"; // String | Configuration key. + try { + File result = apiInstance.getNamedConfiguration(key); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ConfigurationApi#getNamedConfiguration"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **key** | **String**| Configuration key. | | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Configuration returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateConfiguration** +> updateConfiguration(serverConfiguration) + +Updates application configuration. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ConfigurationApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ConfigurationApi apiInstance = new ConfigurationApi(defaultClient); + ServerConfiguration serverConfiguration = new ServerConfiguration(); // ServerConfiguration | Configuration. + try { + apiInstance.updateConfiguration(serverConfiguration); + } catch (ApiException e) { + System.err.println("Exception when calling ConfigurationApi#updateConfiguration"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **serverConfiguration** | [**ServerConfiguration**](ServerConfiguration.md)| Configuration. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Configuration updated. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateNamedConfiguration** +> updateNamedConfiguration(key, body) + +Updates named configuration. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ConfigurationApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ConfigurationApi apiInstance = new ConfigurationApi(defaultClient); + String key = "key_example"; // String | Configuration key. + Object body = null; // Object | Configuration. + try { + apiInstance.updateNamedConfiguration(key, body); + } catch (ApiException e) { + System.err.println("Exception when calling ConfigurationApi#updateNamedConfiguration"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **key** | **String**| Configuration key. | | +| **body** | **Object**| Configuration. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Named configuration updated. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ConfigurationPageInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ConfigurationPageInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ConfigurationPageInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ConfigurationPageInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ContainerProfile.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ContainerProfile.md new file mode 100644 index 0000000000000..e0466d2e6d917 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ContainerProfile.md @@ -0,0 +1,17 @@ + + +# ContainerProfile + +Defines the MediaBrowser.Model.Dlna.ContainerProfile. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**type** | **DlnaProfileType** | Gets or sets the MediaBrowser.Model.Dlna.DlnaProfileType which this container must meet. | [optional] | +|**conditions** | [**List<ProfileCondition>**](ProfileCondition.md) | Gets or sets the list of MediaBrowser.Model.Dlna.ProfileCondition which this container will be applied to. | [optional] | +|**container** | **String** | Gets or sets the container(s) which this container must meet. | [optional] | +|**subContainer** | **String** | Gets or sets the sub container(s) which this container must meet. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/CountryInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CountryInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/CountryInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CountryInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CreatePlaylistDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CreatePlaylistDto.md new file mode 100644 index 0000000000000..47784b69711d3 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CreatePlaylistDto.md @@ -0,0 +1,19 @@ + + +# CreatePlaylistDto + +Create new playlist dto. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**name** | **String** | Gets or sets the name of the new playlist. | [optional] | +|**ids** | **List<UUID>** | Gets or sets item ids to add to the playlist. | [optional] | +|**userId** | **UUID** | Gets or sets the user id. | [optional] | +|**mediaType** | **MediaType** | Gets or sets the media type. | [optional] | +|**users** | [**List<PlaylistUserPermissions>**](PlaylistUserPermissions.md) | Gets or sets the playlist users. | [optional] | +|**isPublic** | **Boolean** | Gets or sets a value indicating whether the playlist is public. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/CreateUserByName.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CreateUserByName.md similarity index 78% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/CreateUserByName.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CreateUserByName.md index 0366a68b00d63..cb7aeaef96709 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/CreateUserByName.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CreateUserByName.md @@ -8,7 +8,7 @@ The create user by name request body. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**name** | **String** | Gets or sets the username. | [optional] | +|**name** | **String** | Gets or sets the username. | | |**password** | **String** | Gets or sets the password. | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/CultureDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CultureDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/CultureDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/CultureDto.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DashboardApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DashboardApi.md new file mode 100644 index 0000000000000..34d8a226218e8 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DashboardApi.md @@ -0,0 +1,141 @@ +# DashboardApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getConfigurationPages**](DashboardApi.md#getConfigurationPages) | **GET** /web/ConfigurationPages | Gets the configuration pages. | +| [**getDashboardConfigurationPage**](DashboardApi.md#getDashboardConfigurationPage) | **GET** /web/ConfigurationPage | Gets a dashboard configuration page. | + + + +# **getConfigurationPages** +> List<ConfigurationPageInfo> getConfigurationPages(enableInMainMenu) + +Gets the configuration pages. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DashboardApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DashboardApi apiInstance = new DashboardApi(defaultClient); + Boolean enableInMainMenu = true; // Boolean | Whether to enable in the main menu. + try { + List result = apiInstance.getConfigurationPages(enableInMainMenu); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DashboardApi#getConfigurationPages"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **enableInMainMenu** | **Boolean**| Whether to enable in the main menu. | [optional] | + +### Return type + +[**List<ConfigurationPageInfo>**](ConfigurationPageInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | ConfigurationPages returned. | - | +| **404** | Server still loading. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getDashboardConfigurationPage** +> File getDashboardConfigurationPage(name) + +Gets a dashboard configuration page. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DashboardApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + DashboardApi apiInstance = new DashboardApi(defaultClient); + String name = "name_example"; // String | The name of the page. + try { + File result = apiInstance.getDashboardConfigurationPage(name); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DashboardApi#getDashboardConfigurationPage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| The name of the page. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/html, application/x-javascript, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | ConfigurationPage returned. | - | +| **404** | Plugin configuration page not found. | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/DayOfWeek.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DayOfWeek.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/DayOfWeek.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DayOfWeek.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/DayPattern.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DayPattern.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/DayPattern.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DayPattern.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/DefaultDirectoryBrowserInfoDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DefaultDirectoryBrowserInfoDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/DefaultDirectoryBrowserInfoDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DefaultDirectoryBrowserInfoDto.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DeinterlaceMethod.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DeinterlaceMethod.md new file mode 100644 index 0000000000000..37fad6a87b82d --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DeinterlaceMethod.md @@ -0,0 +1,13 @@ + + +# DeinterlaceMethod + +## Enum + + +* `YADIF` (value: `"yadif"`) + +* `BWDIF` (value: `"bwdif"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DeviceInfoDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DeviceInfoDto.md new file mode 100644 index 0000000000000..6f5d33e1762c9 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DeviceInfoDto.md @@ -0,0 +1,24 @@ + + +# DeviceInfoDto + +A DTO representing device information. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**name** | **String** | Gets or sets the name. | [optional] | +|**customName** | **String** | Gets or sets the custom name. | [optional] | +|**accessToken** | **String** | Gets or sets the access token. | [optional] | +|**id** | **String** | Gets or sets the identifier. | [optional] | +|**lastUserName** | **String** | Gets or sets the last name of the user. | [optional] | +|**appName** | **String** | Gets or sets the name of the application. | [optional] | +|**appVersion** | **String** | Gets or sets the application version. | [optional] | +|**lastUserId** | **UUID** | Gets or sets the last user identifier. | [optional] | +|**dateLastActivity** | **OffsetDateTime** | Gets or sets the date last modified. | [optional] | +|**capabilities** | [**ClientCapabilitiesDto**](ClientCapabilitiesDto.md) | Gets or sets the capabilities. | [optional] | +|**iconUrl** | **String** | Gets or sets the icon URL. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DeviceInfoDtoQueryResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DeviceInfoDtoQueryResult.md new file mode 100644 index 0000000000000..09a8ac62f3afb --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DeviceInfoDtoQueryResult.md @@ -0,0 +1,16 @@ + + +# DeviceInfoDtoQueryResult + +Query result container. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**items** | [**List<DeviceInfoDto>**](DeviceInfoDto.md) | Gets or sets the items. | [optional] | +|**totalRecordCount** | **Integer** | Gets or sets the total number of records available. | [optional] | +|**startIndex** | **Integer** | Gets or sets the index of the first record in Items. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/DeviceOptionsDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DeviceOptionsDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/DeviceOptionsDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DeviceOptionsDto.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DeviceProfile.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DeviceProfile.md new file mode 100644 index 0000000000000..80ac7814b5c96 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DeviceProfile.md @@ -0,0 +1,24 @@ + + +# DeviceProfile + +A MediaBrowser.Model.Dlna.DeviceProfile represents a set of metadata which determines which content a certain device is able to play.
Specifically, it defines the supported containers and codecs (video and/or audio, including codec profiles and levels) the device is able to direct play (without transcoding or remuxing), as well as which containers/codecs to transcode to in case it isn't. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**name** | **String** | Gets or sets the name of this device profile. User profiles must have a unique name. | [optional] | +|**id** | **UUID** | Gets or sets the unique internal identifier. | [optional] | +|**maxStreamingBitrate** | **Integer** | Gets or sets the maximum allowed bitrate for all streamed content. | [optional] | +|**maxStaticBitrate** | **Integer** | Gets or sets the maximum allowed bitrate for statically streamed content (= direct played files). | [optional] | +|**musicStreamingTranscodingBitrate** | **Integer** | Gets or sets the maximum allowed bitrate for transcoded music streams. | [optional] | +|**maxStaticMusicBitrate** | **Integer** | Gets or sets the maximum allowed bitrate for statically streamed (= direct played) music files. | [optional] | +|**directPlayProfiles** | [**List<DirectPlayProfile>**](DirectPlayProfile.md) | Gets or sets the direct play profiles. | [optional] | +|**transcodingProfiles** | [**List<TranscodingProfile>**](TranscodingProfile.md) | Gets or sets the transcoding profiles. | [optional] | +|**containerProfiles** | [**List<ContainerProfile>**](ContainerProfile.md) | Gets or sets the container profiles. Failing to meet these optional conditions causes transcoding to occur. | [optional] | +|**codecProfiles** | [**List<CodecProfile>**](CodecProfile.md) | Gets or sets the codec profiles. | [optional] | +|**subtitleProfiles** | [**List<SubtitleProfile>**](SubtitleProfile.md) | Gets or sets the subtitle profiles. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DevicesApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DevicesApi.md new file mode 100644 index 0000000000000..c1e06152c8b07 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DevicesApi.md @@ -0,0 +1,361 @@ +# DevicesApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**deleteDevice**](DevicesApi.md#deleteDevice) | **DELETE** /Devices | Deletes a device. | +| [**getDeviceInfo**](DevicesApi.md#getDeviceInfo) | **GET** /Devices/Info | Get info for a device. | +| [**getDeviceOptions**](DevicesApi.md#getDeviceOptions) | **GET** /Devices/Options | Get options for a device. | +| [**getDevices**](DevicesApi.md#getDevices) | **GET** /Devices | Get Devices. | +| [**updateDeviceOptions**](DevicesApi.md#updateDeviceOptions) | **POST** /Devices/Options | Update device options. | + + + +# **deleteDevice** +> deleteDevice(id) + +Deletes a device. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DevicesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DevicesApi apiInstance = new DevicesApi(defaultClient); + String id = "id_example"; // String | Device Id. + try { + apiInstance.deleteDevice(id); + } catch (ApiException e) { + System.err.println("Exception when calling DevicesApi#deleteDevice"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **id** | **String**| Device Id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Device deleted. | - | +| **404** | Device not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getDeviceInfo** +> DeviceInfoDto getDeviceInfo(id) + +Get info for a device. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DevicesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DevicesApi apiInstance = new DevicesApi(defaultClient); + String id = "id_example"; // String | Device Id. + try { + DeviceInfoDto result = apiInstance.getDeviceInfo(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DevicesApi#getDeviceInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **id** | **String**| Device Id. | | + +### Return type + +[**DeviceInfoDto**](DeviceInfoDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Device info retrieved. | - | +| **404** | Device not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getDeviceOptions** +> DeviceOptionsDto getDeviceOptions(id) + +Get options for a device. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DevicesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DevicesApi apiInstance = new DevicesApi(defaultClient); + String id = "id_example"; // String | Device Id. + try { + DeviceOptionsDto result = apiInstance.getDeviceOptions(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DevicesApi#getDeviceOptions"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **id** | **String**| Device Id. | | + +### Return type + +[**DeviceOptionsDto**](DeviceOptionsDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Device options retrieved. | - | +| **404** | Device not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getDevices** +> DeviceInfoDtoQueryResult getDevices(userId) + +Get Devices. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DevicesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DevicesApi apiInstance = new DevicesApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | Gets or sets the user identifier. + try { + DeviceInfoDtoQueryResult result = apiInstance.getDevices(userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DevicesApi#getDevices"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| Gets or sets the user identifier. | [optional] | + +### Return type + +[**DeviceInfoDtoQueryResult**](DeviceInfoDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Devices retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateDeviceOptions** +> updateDeviceOptions(id, deviceOptionsDto) + +Update device options. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DevicesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DevicesApi apiInstance = new DevicesApi(defaultClient); + String id = "id_example"; // String | Device Id. + DeviceOptionsDto deviceOptionsDto = new DeviceOptionsDto(); // DeviceOptionsDto | Device Options. + try { + apiInstance.updateDeviceOptions(id, deviceOptionsDto); + } catch (ApiException e) { + System.err.println("Exception when calling DevicesApi#updateDeviceOptions"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **id** | **String**| Device Id. | | +| **deviceOptionsDto** | [**DeviceOptionsDto**](DeviceOptionsDto.md)| Device Options. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Device options updated. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DirectPlayProfile.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DirectPlayProfile.md new file mode 100644 index 0000000000000..9997ce2f95856 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DirectPlayProfile.md @@ -0,0 +1,17 @@ + + +# DirectPlayProfile + +Defines the MediaBrowser.Model.Dlna.DirectPlayProfile. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**container** | **String** | Gets or sets the container. | [optional] | +|**audioCodec** | **String** | Gets or sets the audio codec. | [optional] | +|**videoCodec** | **String** | Gets or sets the video codec. | [optional] | +|**type** | **DlnaProfileType** | Gets or sets the Dlna profile type. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DisplayPreferencesApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DisplayPreferencesApi.md new file mode 100644 index 0000000000000..a4b03eb1611f2 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DisplayPreferencesApi.md @@ -0,0 +1,157 @@ +# DisplayPreferencesApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getDisplayPreferences**](DisplayPreferencesApi.md#getDisplayPreferences) | **GET** /DisplayPreferences/{displayPreferencesId} | Get Display Preferences. | +| [**updateDisplayPreferences**](DisplayPreferencesApi.md#updateDisplayPreferences) | **POST** /DisplayPreferences/{displayPreferencesId} | Update Display Preferences. | + + + +# **getDisplayPreferences** +> DisplayPreferencesDto getDisplayPreferences(displayPreferencesId, client, userId) + +Get Display Preferences. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DisplayPreferencesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DisplayPreferencesApi apiInstance = new DisplayPreferencesApi(defaultClient); + String displayPreferencesId = "displayPreferencesId_example"; // String | Display preferences id. + String client = "client_example"; // String | Client. + UUID userId = UUID.randomUUID(); // UUID | User id. + try { + DisplayPreferencesDto result = apiInstance.getDisplayPreferences(displayPreferencesId, client, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DisplayPreferencesApi#getDisplayPreferences"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **displayPreferencesId** | **String**| Display preferences id. | | +| **client** | **String**| Client. | | +| **userId** | **UUID**| User id. | [optional] | + +### Return type + +[**DisplayPreferencesDto**](DisplayPreferencesDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Display preferences retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateDisplayPreferences** +> updateDisplayPreferences(displayPreferencesId, client, displayPreferencesDto, userId) + +Update Display Preferences. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DisplayPreferencesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DisplayPreferencesApi apiInstance = new DisplayPreferencesApi(defaultClient); + String displayPreferencesId = "displayPreferencesId_example"; // String | Display preferences id. + String client = "client_example"; // String | Client. + DisplayPreferencesDto displayPreferencesDto = new DisplayPreferencesDto(); // DisplayPreferencesDto | New Display Preferences object. + UUID userId = UUID.randomUUID(); // UUID | User Id. + try { + apiInstance.updateDisplayPreferences(displayPreferencesId, client, displayPreferencesDto, userId); + } catch (ApiException e) { + System.err.println("Exception when calling DisplayPreferencesApi#updateDisplayPreferences"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **displayPreferencesId** | **String**| Display preferences id. | | +| **client** | **String**| Client. | | +| **displayPreferencesDto** | [**DisplayPreferencesDto**](DisplayPreferencesDto.md)| New Display Preferences object. | | +| **userId** | **UUID**| User Id. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Display preferences updated. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/DisplayPreferencesDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DisplayPreferencesDto.md similarity index 86% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/DisplayPreferencesDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DisplayPreferencesDto.md index 784ebf16e08c8..f81bf37b963f7 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/DisplayPreferencesDto.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DisplayPreferencesDto.md @@ -16,10 +16,10 @@ Defines the display preferences for any item that supports them (usually Folders |**primaryImageHeight** | **Integer** | Gets or sets the height of the primary image. | [optional] | |**primaryImageWidth** | **Integer** | Gets or sets the width of the primary image. | [optional] | |**customPrefs** | **Map<String, String>** | Gets or sets the custom prefs. | [optional] | -|**scrollDirection** | **ScrollDirection** | Gets or sets the scroll direction. | [optional] | +|**scrollDirection** | **ScrollDirection** | An enum representing the axis that should be scrolled. | [optional] | |**showBackdrop** | **Boolean** | Gets or sets a value indicating whether to show backdrops on this item. | [optional] | |**rememberSorting** | **Boolean** | Gets or sets a value indicating whether [remember sorting]. | [optional] | -|**sortOrder** | **SortOrder** | Gets or sets the sort order. | [optional] | +|**sortOrder** | **SortOrder** | An enum representing the sorting order. | [optional] | |**showSidebar** | **Boolean** | Gets or sets a value indicating whether [show sidebar]. | [optional] | |**client** | **String** | Gets or sets the client. | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/DlnaProfileType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DlnaProfileType.md similarity index 84% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/DlnaProfileType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DlnaProfileType.md index 212f4c6385e5d..cc93228dd93aa 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/DlnaProfileType.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DlnaProfileType.md @@ -13,5 +13,7 @@ * `SUBTITLE` (value: `"Subtitle"`) +* `LYRIC` (value: `"Lyric"`) + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DownMixStereoAlgorithms.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DownMixStereoAlgorithms.md new file mode 100644 index 0000000000000..c518f981298df --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DownMixStereoAlgorithms.md @@ -0,0 +1,19 @@ + + +# DownMixStereoAlgorithms + +## Enum + + +* `NONE` (value: `"None"`) + +* `DAVE750` (value: `"Dave750"`) + +* `NIGHTMODE_DIALOGUE` (value: `"NightmodeDialogue"`) + +* `RFC7845` (value: `"Rfc7845"`) + +* `AC4` (value: `"Ac4"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/DynamicDayOfWeek.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DynamicDayOfWeek.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/DynamicDayOfWeek.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DynamicDayOfWeek.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DynamicHlsApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DynamicHlsApi.md new file mode 100644 index 0000000000000..90b0e5a10d6fe --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/DynamicHlsApi.md @@ -0,0 +1,1576 @@ +# DynamicHlsApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getHlsAudioSegment**](DynamicHlsApi.md#getHlsAudioSegment) | **GET** /Audio/{itemId}/hls1/{playlistId}/{segmentId}.{container} | Gets a video stream using HTTP live streaming. | +| [**getHlsVideoSegment**](DynamicHlsApi.md#getHlsVideoSegment) | **GET** /Videos/{itemId}/hls1/{playlistId}/{segmentId}.{container} | Gets a video stream using HTTP live streaming. | +| [**getLiveHlsStream**](DynamicHlsApi.md#getLiveHlsStream) | **GET** /Videos/{itemId}/live.m3u8 | Gets a hls live stream. | +| [**getMasterHlsAudioPlaylist**](DynamicHlsApi.md#getMasterHlsAudioPlaylist) | **GET** /Audio/{itemId}/master.m3u8 | Gets an audio hls playlist stream. | +| [**getMasterHlsVideoPlaylist**](DynamicHlsApi.md#getMasterHlsVideoPlaylist) | **GET** /Videos/{itemId}/master.m3u8 | Gets a video hls playlist stream. | +| [**getVariantHlsAudioPlaylist**](DynamicHlsApi.md#getVariantHlsAudioPlaylist) | **GET** /Audio/{itemId}/main.m3u8 | Gets an audio stream using HTTP live streaming. | +| [**getVariantHlsVideoPlaylist**](DynamicHlsApi.md#getVariantHlsVideoPlaylist) | **GET** /Videos/{itemId}/main.m3u8 | Gets a video stream using HTTP live streaming. | +| [**headMasterHlsAudioPlaylist**](DynamicHlsApi.md#headMasterHlsAudioPlaylist) | **HEAD** /Audio/{itemId}/master.m3u8 | Gets an audio hls playlist stream. | +| [**headMasterHlsVideoPlaylist**](DynamicHlsApi.md#headMasterHlsVideoPlaylist) | **HEAD** /Videos/{itemId}/master.m3u8 | Gets a video hls playlist stream. | + + + +# **getHlsAudioSegment** +> File getHlsAudioSegment(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding) + +Gets a video stream using HTTP live streaming. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DynamicHlsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DynamicHlsApi apiInstance = new DynamicHlsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String playlistId = "playlistId_example"; // String | The playlist id. + Integer segmentId = 56; // Integer | The segment id. + String container = "container_example"; // String | The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. + Long runtimeTicks = 56L; // Long | The position of the requested segment in ticks. + Long actualSegmentLengthTicks = 56L; // Long | The length of the requested segment in ticks. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer maxStreamingBitrate = 56; // Integer | Optional. The maximum streaming bitrate. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamorphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + try { + File result = apiInstance.getHlsAudioSegment(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DynamicHlsApi#getHlsAudioSegment"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **playlistId** | **String**| The playlist id. | | +| **segmentId** | **Integer**| The segment id. | | +| **container** | **String**| The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. | | +| **runtimeTicks** | **Long**| The position of the requested segment in ticks. | | +| **actualSegmentLengthTicks** | **Long**| The length of the requested segment in ticks. | | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **maxStreamingBitrate** | **Integer**| Optional. The maximum streaming bitrate. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamorphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: audio/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Video stream returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getHlsVideoSegment** +> File getHlsVideoSegment(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding) + +Gets a video stream using HTTP live streaming. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DynamicHlsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DynamicHlsApi apiInstance = new DynamicHlsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String playlistId = "playlistId_example"; // String | The playlist id. + Integer segmentId = 56; // Integer | The segment id. + String container = "container_example"; // String | The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. + Long runtimeTicks = 56L; // Long | The position of the requested segment in ticks. + Long actualSegmentLengthTicks = 56L; // Long | The length of the requested segment in ticks. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The desired segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer maxWidth = 56; // Integer | Optional. The maximum horizontal resolution of the encoded video. + Integer maxHeight = 56; // Integer | Optional. The maximum vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamorphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + Boolean alwaysBurnInSubtitleWhenTranscoding = false; // Boolean | Whether to always burn in subtitles when transcoding. + try { + File result = apiInstance.getHlsVideoSegment(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DynamicHlsApi#getHlsVideoSegment"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **playlistId** | **String**| The playlist id. | | +| **segmentId** | **Integer**| The segment id. | | +| **container** | **String**| The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. | | +| **runtimeTicks** | **Long**| The position of the requested segment in ticks. | | +| **actualSegmentLengthTicks** | **Long**| The length of the requested segment in ticks. | | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The desired segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **maxWidth** | **Integer**| Optional. The maximum horizontal resolution of the encoded video. | [optional] | +| **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamorphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | +| **alwaysBurnInSubtitleWhenTranscoding** | **Boolean**| Whether to always burn in subtitles when transcoding. | [optional] [default to false] | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: video/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Video stream returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getLiveHlsStream** +> File getLiveHlsStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, maxWidth, maxHeight, enableSubtitlesInManifest, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding) + +Gets a hls live stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DynamicHlsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DynamicHlsApi apiInstance = new DynamicHlsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String container = "container_example"; // String | The audio container. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamorphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Integer maxWidth = 56; // Integer | Optional. The max width. + Integer maxHeight = 56; // Integer | Optional. The max height. + Boolean enableSubtitlesInManifest = true; // Boolean | Optional. Whether to enable subtitles in the manifest. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + Boolean alwaysBurnInSubtitleWhenTranscoding = false; // Boolean | Whether to always burn in subtitles when transcoding. + try { + File result = apiInstance.getLiveHlsStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, maxWidth, maxHeight, enableSubtitlesInManifest, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DynamicHlsApi#getLiveHlsStream"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **container** | **String**| The audio container. | [optional] | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamorphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **maxWidth** | **Integer**| Optional. The max width. | [optional] | +| **maxHeight** | **Integer**| Optional. The max height. | [optional] | +| **enableSubtitlesInManifest** | **Boolean**| Optional. Whether to enable subtitles in the manifest. | [optional] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | +| **alwaysBurnInSubtitleWhenTranscoding** | **Boolean**| Whether to always burn in subtitles when transcoding. | [optional] [default to false] | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/x-mpegURL + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Hls live stream retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getMasterHlsAudioPlaylist** +> File getMasterHlsAudioPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding) + +Gets an audio hls playlist stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DynamicHlsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DynamicHlsApi apiInstance = new DynamicHlsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer maxStreamingBitrate = 56; // Integer | Optional. The maximum streaming bitrate. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamorphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAdaptiveBitrateStreaming = true; // Boolean | Enable adaptive bitrate streaming. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + try { + File result = apiInstance.getMasterHlsAudioPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DynamicHlsApi#getMasterHlsAudioPlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **maxStreamingBitrate** | **Integer**| Optional. The maximum streaming bitrate. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamorphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAdaptiveBitrateStreaming** | **Boolean**| Enable adaptive bitrate streaming. | [optional] [default to true] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/x-mpegURL + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Audio stream returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getMasterHlsVideoPlaylist** +> File getMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding) + +Gets a video hls playlist stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DynamicHlsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DynamicHlsApi apiInstance = new DynamicHlsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer maxWidth = 56; // Integer | Optional. The maximum horizontal resolution of the encoded video. + Integer maxHeight = 56; // Integer | Optional. The maximum vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamorphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAdaptiveBitrateStreaming = true; // Boolean | Enable adaptive bitrate streaming. + Boolean enableTrickplay = true; // Boolean | Enable trickplay image playlists being added to master playlist. + Boolean enableAudioVbrEncoding = true; // Boolean | Whether to enable Audio Encoding. + Boolean alwaysBurnInSubtitleWhenTranscoding = false; // Boolean | Whether to always burn in subtitles when transcoding. + try { + File result = apiInstance.getMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DynamicHlsApi#getMasterHlsVideoPlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **maxWidth** | **Integer**| Optional. The maximum horizontal resolution of the encoded video. | [optional] | +| **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamorphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAdaptiveBitrateStreaming** | **Boolean**| Enable adaptive bitrate streaming. | [optional] [default to true] | +| **enableTrickplay** | **Boolean**| Enable trickplay image playlists being added to master playlist. | [optional] [default to true] | +| **enableAudioVbrEncoding** | **Boolean**| Whether to enable Audio Encoding. | [optional] [default to true] | +| **alwaysBurnInSubtitleWhenTranscoding** | **Boolean**| Whether to always burn in subtitles when transcoding. | [optional] [default to false] | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/x-mpegURL + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Video stream returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getVariantHlsAudioPlaylist** +> File getVariantHlsAudioPlaylist(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding) + +Gets an audio stream using HTTP live streaming. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DynamicHlsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DynamicHlsApi apiInstance = new DynamicHlsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer maxStreamingBitrate = 56; // Integer | Optional. The maximum streaming bitrate. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamorphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + try { + File result = apiInstance.getVariantHlsAudioPlaylist(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DynamicHlsApi#getVariantHlsAudioPlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **maxStreamingBitrate** | **Integer**| Optional. The maximum streaming bitrate. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamorphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/x-mpegURL + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Audio stream returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getVariantHlsVideoPlaylist** +> File getVariantHlsVideoPlaylist(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding) + +Gets a video stream using HTTP live streaming. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DynamicHlsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DynamicHlsApi apiInstance = new DynamicHlsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer maxWidth = 56; // Integer | Optional. The maximum horizontal resolution of the encoded video. + Integer maxHeight = 56; // Integer | Optional. The maximum vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamorphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + Boolean alwaysBurnInSubtitleWhenTranscoding = false; // Boolean | Whether to always burn in subtitles when transcoding. + try { + File result = apiInstance.getVariantHlsVideoPlaylist(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DynamicHlsApi#getVariantHlsVideoPlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **maxWidth** | **Integer**| Optional. The maximum horizontal resolution of the encoded video. | [optional] | +| **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamorphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | +| **alwaysBurnInSubtitleWhenTranscoding** | **Boolean**| Whether to always burn in subtitles when transcoding. | [optional] [default to false] | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/x-mpegURL + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Video stream returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **headMasterHlsAudioPlaylist** +> File headMasterHlsAudioPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding) + +Gets an audio hls playlist stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DynamicHlsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DynamicHlsApi apiInstance = new DynamicHlsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer maxStreamingBitrate = 56; // Integer | Optional. The maximum streaming bitrate. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamorphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAdaptiveBitrateStreaming = true; // Boolean | Enable adaptive bitrate streaming. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + try { + File result = apiInstance.headMasterHlsAudioPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DynamicHlsApi#headMasterHlsAudioPlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **maxStreamingBitrate** | **Integer**| Optional. The maximum streaming bitrate. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamorphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAdaptiveBitrateStreaming** | **Boolean**| Enable adaptive bitrate streaming. | [optional] [default to true] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/x-mpegURL + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Audio stream returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **headMasterHlsVideoPlaylist** +> File headMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding) + +Gets a video hls playlist stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.DynamicHlsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + DynamicHlsApi apiInstance = new DynamicHlsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer maxWidth = 56; // Integer | Optional. The maximum horizontal resolution of the encoded video. + Integer maxHeight = 56; // Integer | Optional. The maximum vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamorphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAdaptiveBitrateStreaming = true; // Boolean | Enable adaptive bitrate streaming. + Boolean enableTrickplay = true; // Boolean | Enable trickplay image playlists being added to master playlist. + Boolean enableAudioVbrEncoding = true; // Boolean | Whether to enable Audio Encoding. + Boolean alwaysBurnInSubtitleWhenTranscoding = false; // Boolean | Whether to always burn in subtitles when transcoding. + try { + File result = apiInstance.headMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DynamicHlsApi#headMasterHlsVideoPlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **maxWidth** | **Integer**| Optional. The maximum horizontal resolution of the encoded video. | [optional] | +| **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamorphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAdaptiveBitrateStreaming** | **Boolean**| Enable adaptive bitrate streaming. | [optional] [default to true] | +| **enableTrickplay** | **Boolean**| Enable trickplay image playlists being added to master playlist. | [optional] [default to true] | +| **enableAudioVbrEncoding** | **Boolean**| Whether to enable Audio Encoding. | [optional] [default to true] | +| **alwaysBurnInSubtitleWhenTranscoding** | **Boolean**| Whether to always burn in subtitles when transcoding. | [optional] [default to false] | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/x-mpegURL + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Video stream returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/EmbeddedSubtitleOptions.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/EmbeddedSubtitleOptions.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/EmbeddedSubtitleOptions.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/EmbeddedSubtitleOptions.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/EncoderPreset.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/EncoderPreset.md new file mode 100644 index 0000000000000..c6f7daa97ba5a --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/EncoderPreset.md @@ -0,0 +1,31 @@ + + +# EncoderPreset + +## Enum + + +* `AUTO` (value: `"auto"`) + +* `PLACEBO` (value: `"placebo"`) + +* `VERYSLOW` (value: `"veryslow"`) + +* `SLOWER` (value: `"slower"`) + +* `SLOW` (value: `"slow"`) + +* `MEDIUM` (value: `"medium"`) + +* `FAST` (value: `"fast"`) + +* `FASTER` (value: `"faster"`) + +* `VERYFAST` (value: `"veryfast"`) + +* `SUPERFAST` (value: `"superfast"`) + +* `ULTRAFAST` (value: `"ultrafast"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/EncodingContext.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/EncodingContext.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/EncodingContext.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/EncodingContext.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/EncodingOptions.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/EncodingOptions.md new file mode 100644 index 0000000000000..1f16d8ff1fc25 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/EncodingOptions.md @@ -0,0 +1,60 @@ + + +# EncodingOptions + +Class EncodingOptions. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**encodingThreadCount** | **Integer** | Gets or sets the thread count used for encoding. | [optional] | +|**transcodingTempPath** | **String** | Gets or sets the temporary transcoding path. | [optional] | +|**fallbackFontPath** | **String** | Gets or sets the path to the fallback font. | [optional] | +|**enableFallbackFont** | **Boolean** | Gets or sets a value indicating whether to use the fallback font. | [optional] | +|**enableAudioVbr** | **Boolean** | Gets or sets a value indicating whether audio VBR is enabled. | [optional] | +|**downMixAudioBoost** | **Double** | Gets or sets the audio boost applied when downmixing audio. | [optional] | +|**downMixStereoAlgorithm** | **DownMixStereoAlgorithms** | Gets or sets the algorithm used for downmixing audio to stereo. | [optional] | +|**maxMuxingQueueSize** | **Integer** | Gets or sets the maximum size of the muxing queue. | [optional] | +|**enableThrottling** | **Boolean** | Gets or sets a value indicating whether throttling is enabled. | [optional] | +|**throttleDelaySeconds** | **Integer** | Gets or sets the delay after which throttling happens. | [optional] | +|**enableSegmentDeletion** | **Boolean** | Gets or sets a value indicating whether segment deletion is enabled. | [optional] | +|**segmentKeepSeconds** | **Integer** | Gets or sets seconds for which segments should be kept before being deleted. | [optional] | +|**hardwareAccelerationType** | **HardwareAccelerationType** | Gets or sets the hardware acceleration type. | [optional] | +|**encoderAppPath** | **String** | Gets or sets the FFmpeg path as set by the user via the UI. | [optional] | +|**encoderAppPathDisplay** | **String** | Gets or sets the current FFmpeg path being used by the system and displayed on the transcode page. | [optional] | +|**vaapiDevice** | **String** | Gets or sets the VA-API device. | [optional] | +|**qsvDevice** | **String** | Gets or sets the QSV device. | [optional] | +|**enableTonemapping** | **Boolean** | Gets or sets a value indicating whether tonemapping is enabled. | [optional] | +|**enableVppTonemapping** | **Boolean** | Gets or sets a value indicating whether VPP tonemapping is enabled. | [optional] | +|**enableVideoToolboxTonemapping** | **Boolean** | Gets or sets a value indicating whether videotoolbox tonemapping is enabled. | [optional] | +|**tonemappingAlgorithm** | **TonemappingAlgorithm** | Gets or sets the tone-mapping algorithm. | [optional] | +|**tonemappingMode** | **TonemappingMode** | Gets or sets the tone-mapping mode. | [optional] | +|**tonemappingRange** | **TonemappingRange** | Gets or sets the tone-mapping range. | [optional] | +|**tonemappingDesat** | **Double** | Gets or sets the tone-mapping desaturation. | [optional] | +|**tonemappingPeak** | **Double** | Gets or sets the tone-mapping peak. | [optional] | +|**tonemappingParam** | **Double** | Gets or sets the tone-mapping parameters. | [optional] | +|**vppTonemappingBrightness** | **Double** | Gets or sets the VPP tone-mapping brightness. | [optional] | +|**vppTonemappingContrast** | **Double** | Gets or sets the VPP tone-mapping contrast. | [optional] | +|**h264Crf** | **Integer** | Gets or sets the H264 CRF. | [optional] | +|**h265Crf** | **Integer** | Gets or sets the H265 CRF. | [optional] | +|**encoderPreset** | **EncoderPreset** | Gets or sets the encoder preset. | [optional] | +|**deinterlaceDoubleRate** | **Boolean** | Gets or sets a value indicating whether the framerate is doubled when deinterlacing. | [optional] | +|**deinterlaceMethod** | **DeinterlaceMethod** | Gets or sets the deinterlace method. | [optional] | +|**enableDecodingColorDepth10Hevc** | **Boolean** | Gets or sets a value indicating whether 10bit HEVC decoding is enabled. | [optional] | +|**enableDecodingColorDepth10Vp9** | **Boolean** | Gets or sets a value indicating whether 10bit VP9 decoding is enabled. | [optional] | +|**enableDecodingColorDepth10HevcRext** | **Boolean** | Gets or sets a value indicating whether 8/10bit HEVC RExt decoding is enabled. | [optional] | +|**enableDecodingColorDepth12HevcRext** | **Boolean** | Gets or sets a value indicating whether 12bit HEVC RExt decoding is enabled. | [optional] | +|**enableEnhancedNvdecDecoder** | **Boolean** | Gets or sets a value indicating whether the enhanced NVDEC is enabled. | [optional] | +|**preferSystemNativeHwDecoder** | **Boolean** | Gets or sets a value indicating whether the system native hardware decoder should be used. | [optional] | +|**enableIntelLowPowerH264HwEncoder** | **Boolean** | Gets or sets a value indicating whether the Intel H264 low-power hardware encoder should be used. | [optional] | +|**enableIntelLowPowerHevcHwEncoder** | **Boolean** | Gets or sets a value indicating whether the Intel HEVC low-power hardware encoder should be used. | [optional] | +|**enableHardwareEncoding** | **Boolean** | Gets or sets a value indicating whether hardware encoding is enabled. | [optional] | +|**allowHevcEncoding** | **Boolean** | Gets or sets a value indicating whether HEVC encoding is enabled. | [optional] | +|**allowAv1Encoding** | **Boolean** | Gets or sets a value indicating whether AV1 encoding is enabled. | [optional] | +|**enableSubtitleExtraction** | **Boolean** | Gets or sets a value indicating whether subtitle extraction is enabled. | [optional] | +|**hardwareDecodingCodecs** | **List<String>** | Gets or sets the codecs hardware encoding is used for. | [optional] | +|**allowOnDemandMetadataBasedKeyframeExtractionForExtensions** | **List<String>** | Gets or sets the file extensions on-demand metadata based keyframe extraction is enabled for. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/EndPointInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/EndPointInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/EndPointInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/EndPointInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/EnvironmentApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/EnvironmentApi.md new file mode 100644 index 0000000000000..d502c293cdd78 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/EnvironmentApi.md @@ -0,0 +1,420 @@ +# EnvironmentApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getDefaultDirectoryBrowser**](EnvironmentApi.md#getDefaultDirectoryBrowser) | **GET** /Environment/DefaultDirectoryBrowser | Get Default directory browser. | +| [**getDirectoryContents**](EnvironmentApi.md#getDirectoryContents) | **GET** /Environment/DirectoryContents | Gets the contents of a given directory in the file system. | +| [**getDrives**](EnvironmentApi.md#getDrives) | **GET** /Environment/Drives | Gets available drives from the server's file system. | +| [**getNetworkShares**](EnvironmentApi.md#getNetworkShares) | **GET** /Environment/NetworkShares | Gets network paths. | +| [**getParentPath**](EnvironmentApi.md#getParentPath) | **GET** /Environment/ParentPath | Gets the parent path of a given path. | +| [**validatePath**](EnvironmentApi.md#validatePath) | **POST** /Environment/ValidatePath | Validates path. | + + + +# **getDefaultDirectoryBrowser** +> DefaultDirectoryBrowserInfoDto getDefaultDirectoryBrowser() + +Get Default directory browser. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.EnvironmentApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + EnvironmentApi apiInstance = new EnvironmentApi(defaultClient); + try { + DefaultDirectoryBrowserInfoDto result = apiInstance.getDefaultDirectoryBrowser(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling EnvironmentApi#getDefaultDirectoryBrowser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**DefaultDirectoryBrowserInfoDto**](DefaultDirectoryBrowserInfoDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Default directory browser returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getDirectoryContents** +> List<FileSystemEntryInfo> getDirectoryContents(path, includeFiles, includeDirectories) + +Gets the contents of a given directory in the file system. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.EnvironmentApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + EnvironmentApi apiInstance = new EnvironmentApi(defaultClient); + String path = "path_example"; // String | The path. + Boolean includeFiles = false; // Boolean | An optional filter to include or exclude files from the results. true/false. + Boolean includeDirectories = false; // Boolean | An optional filter to include or exclude folders from the results. true/false. + try { + List result = apiInstance.getDirectoryContents(path, includeFiles, includeDirectories); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling EnvironmentApi#getDirectoryContents"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **path** | **String**| The path. | | +| **includeFiles** | **Boolean**| An optional filter to include or exclude files from the results. true/false. | [optional] [default to false] | +| **includeDirectories** | **Boolean**| An optional filter to include or exclude folders from the results. true/false. | [optional] [default to false] | + +### Return type + +[**List<FileSystemEntryInfo>**](FileSystemEntryInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Directory contents returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getDrives** +> List<FileSystemEntryInfo> getDrives() + +Gets available drives from the server's file system. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.EnvironmentApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + EnvironmentApi apiInstance = new EnvironmentApi(defaultClient); + try { + List result = apiInstance.getDrives(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling EnvironmentApi#getDrives"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<FileSystemEntryInfo>**](FileSystemEntryInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | List of entries returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getNetworkShares** +> List<FileSystemEntryInfo> getNetworkShares() + +Gets network paths. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.EnvironmentApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + EnvironmentApi apiInstance = new EnvironmentApi(defaultClient); + try { + List result = apiInstance.getNetworkShares(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling EnvironmentApi#getNetworkShares"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<FileSystemEntryInfo>**](FileSystemEntryInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Empty array returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getParentPath** +> String getParentPath(path) + +Gets the parent path of a given path. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.EnvironmentApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + EnvironmentApi apiInstance = new EnvironmentApi(defaultClient); + String path = "path_example"; // String | The path. + try { + String result = apiInstance.getParentPath(path); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling EnvironmentApi#getParentPath"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **path** | **String**| The path. | | + +### Return type + +**String** + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **validatePath** +> validatePath(validatePathDto) + +Validates path. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.EnvironmentApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + EnvironmentApi apiInstance = new EnvironmentApi(defaultClient); + ValidatePathDto validatePathDto = new ValidatePathDto(); // ValidatePathDto | Validate request object. + try { + apiInstance.validatePath(validatePathDto); + } catch (ApiException e) { + System.err.println("Exception when calling EnvironmentApi#validatePath"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **validatePathDto** | [**ValidatePathDto**](ValidatePathDto.md)| Validate request object. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Path validated. | - | +| **404** | Path not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ExternalIdInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ExternalIdInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ExternalIdInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ExternalIdInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/ExternalIdMediaType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ExternalIdMediaType.md similarity index 94% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/ExternalIdMediaType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ExternalIdMediaType.md index 6e13de008ef88..fcb7fd41ab7fe 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/ExternalIdMediaType.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ExternalIdMediaType.md @@ -29,5 +29,7 @@ * `TRACK` (value: `"Track"`) +* `BOOK` (value: `"Book"`) + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ExternalUrl.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ExternalUrl.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ExternalUrl.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ExternalUrl.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ExtraType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ExtraType.md new file mode 100644 index 0000000000000..60f0bef34acaa --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ExtraType.md @@ -0,0 +1,33 @@ + + +# ExtraType + +## Enum + + +* `UNKNOWN` (value: `"Unknown"`) + +* `CLIP` (value: `"Clip"`) + +* `TRAILER` (value: `"Trailer"`) + +* `BEHIND_THE_SCENES` (value: `"BehindTheScenes"`) + +* `DELETED_SCENE` (value: `"DeletedScene"`) + +* `INTERVIEW` (value: `"Interview"`) + +* `SCENE` (value: `"Scene"`) + +* `SAMPLE` (value: `"Sample"`) + +* `THEME_SONG` (value: `"ThemeSong"`) + +* `THEME_VIDEO` (value: `"ThemeVideo"`) + +* `FEATURETTE` (value: `"Featurette"`) + +* `SHORT` (value: `"Short"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/FileSystemEntryInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/FileSystemEntryInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/FileSystemEntryInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/FileSystemEntryInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/FileSystemEntryType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/FileSystemEntryType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/FileSystemEntryType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/FileSystemEntryType.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/FilterApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/FilterApi.md new file mode 100644 index 0000000000000..11ca9d84da984 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/FilterApi.md @@ -0,0 +1,172 @@ +# FilterApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getQueryFilters**](FilterApi.md#getQueryFilters) | **GET** /Items/Filters2 | Gets query filters. | +| [**getQueryFiltersLegacy**](FilterApi.md#getQueryFiltersLegacy) | **GET** /Items/Filters | Gets legacy query filters. | + + + +# **getQueryFilters** +> QueryFilters getQueryFilters(userId, parentId, includeItemTypes, isAiring, isMovie, isSports, isKids, isNews, isSeries, recursive) + +Gets query filters. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FilterApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + FilterApi apiInstance = new FilterApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | Optional. User id. + UUID parentId = UUID.randomUUID(); // UUID | Optional. Specify this to localize the search to a specific item or folder. Omit to use the root. + List includeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. + Boolean isAiring = true; // Boolean | Optional. Is item airing. + Boolean isMovie = true; // Boolean | Optional. Is item movie. + Boolean isSports = true; // Boolean | Optional. Is item sports. + Boolean isKids = true; // Boolean | Optional. Is item kids. + Boolean isNews = true; // Boolean | Optional. Is item news. + Boolean isSeries = true; // Boolean | Optional. Is item series. + Boolean recursive = true; // Boolean | Optional. Search recursive. + try { + QueryFilters result = apiInstance.getQueryFilters(userId, parentId, includeItemTypes, isAiring, isMovie, isSports, isKids, isNews, isSeries, recursive); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FilterApi#getQueryFilters"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| Optional. User id. | [optional] | +| **parentId** | **UUID**| Optional. Specify this to localize the search to a specific item or folder. Omit to use the root. | [optional] | +| **includeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. | [optional] | +| **isAiring** | **Boolean**| Optional. Is item airing. | [optional] | +| **isMovie** | **Boolean**| Optional. Is item movie. | [optional] | +| **isSports** | **Boolean**| Optional. Is item sports. | [optional] | +| **isKids** | **Boolean**| Optional. Is item kids. | [optional] | +| **isNews** | **Boolean**| Optional. Is item news. | [optional] | +| **isSeries** | **Boolean**| Optional. Is item series. | [optional] | +| **recursive** | **Boolean**| Optional. Search recursive. | [optional] | + +### Return type + +[**QueryFilters**](QueryFilters.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Filters retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getQueryFiltersLegacy** +> QueryFiltersLegacy getQueryFiltersLegacy(userId, parentId, includeItemTypes, mediaTypes) + +Gets legacy query filters. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FilterApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + FilterApi apiInstance = new FilterApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | Optional. User id. + UUID parentId = UUID.randomUUID(); // UUID | Optional. Parent id. + List includeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. + List mediaTypes = Arrays.asList(); // List | Optional. Filter by MediaType. Allows multiple, comma delimited. + try { + QueryFiltersLegacy result = apiInstance.getQueryFiltersLegacy(userId, parentId, includeItemTypes, mediaTypes); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FilterApi#getQueryFiltersLegacy"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| Optional. User id. | [optional] | +| **parentId** | **UUID**| Optional. Parent id. | [optional] | +| **includeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. | [optional] | +| **mediaTypes** | [**List<MediaType>**](MediaType.md)| Optional. Filter by MediaType. Allows multiple, comma delimited. | [optional] | + +### Return type + +[**QueryFiltersLegacy**](QueryFiltersLegacy.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Legacy filters retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/FontFile.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/FontFile.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/FontFile.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/FontFile.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ForceKeepAliveMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ForceKeepAliveMessage.md new file mode 100644 index 0000000000000..e6311bfa1a0f3 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ForceKeepAliveMessage.md @@ -0,0 +1,16 @@ + + +# ForceKeepAliveMessage + +Force keep alive websocket messages. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | **Integer** | Gets or sets the data. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ForgotPasswordAction.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ForgotPasswordAction.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ForgotPasswordAction.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ForgotPasswordAction.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ForgotPasswordDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ForgotPasswordDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ForgotPasswordDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ForgotPasswordDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ForgotPasswordPinDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ForgotPasswordPinDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ForgotPasswordPinDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ForgotPasswordPinDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ForgotPasswordResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ForgotPasswordResult.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ForgotPasswordResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ForgotPasswordResult.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GeneralCommand.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GeneralCommand.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GeneralCommand.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GeneralCommand.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GeneralCommandMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GeneralCommandMessage.md new file mode 100644 index 0000000000000..0710989cbfd84 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GeneralCommandMessage.md @@ -0,0 +1,16 @@ + + +# GeneralCommandMessage + +General command websocket message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**GeneralCommand**](GeneralCommand.md) | Gets or sets the data. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/GeneralCommandType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GeneralCommandType.md similarity index 97% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/GeneralCommandType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GeneralCommandType.md index 4cce1d5e14b04..0592366c6fd7f 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/GeneralCommandType.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GeneralCommandType.md @@ -89,5 +89,7 @@ * `SET_MAX_STREAMING_BITRATE` (value: `"SetMaxStreamingBitrate"`) +* `SET_PLAYBACK_ORDER` (value: `"SetPlaybackOrder"`) + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GenresApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GenresApi.md new file mode 100644 index 0000000000000..852ae01bf258e --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GenresApi.md @@ -0,0 +1,184 @@ +# GenresApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getGenre**](GenresApi.md#getGenre) | **GET** /Genres/{genreName} | Gets a genre, by name. | +| [**getGenres**](GenresApi.md#getGenres) | **GET** /Genres | Gets all genres from a given item, folder, or the entire library. | + + + +# **getGenre** +> BaseItemDto getGenre(genreName, userId) + +Gets a genre, by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.GenresApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + GenresApi apiInstance = new GenresApi(defaultClient); + String genreName = "genreName_example"; // String | The genre name. + UUID userId = UUID.randomUUID(); // UUID | The user id. + try { + BaseItemDto result = apiInstance.getGenre(genreName, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling GenresApi#getGenre"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **genreName** | **String**| The genre name. | | +| **userId** | **UUID**| The user id. | [optional] | + +### Return type + +[**BaseItemDto**](BaseItemDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Genres returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getGenres** +> BaseItemDtoQueryResult getGenres(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount) + +Gets all genres from a given item, folder, or the entire library. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.GenresApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + GenresApi apiInstance = new GenresApi(defaultClient); + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + String searchTerm = "searchTerm_example"; // String | The search term. + UUID parentId = UUID.randomUUID(); // UUID | Specify this to localize the search to a specific item or folder. Omit to use the root. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + List excludeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. + List includeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered in based on item type. This allows multiple, comma delimited. + Boolean isFavorite = true; // Boolean | Optional filter by items that are marked as favorite, or not. + Integer imageTypeLimit = 56; // Integer | Optional, the max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + UUID userId = UUID.randomUUID(); // UUID | User id. + String nameStartsWithOrGreater = "nameStartsWithOrGreater_example"; // String | Optional filter by items whose name is sorted equally or greater than a given input string. + String nameStartsWith = "nameStartsWith_example"; // String | Optional filter by items whose name is sorted equally than a given input string. + String nameLessThan = "nameLessThan_example"; // String | Optional filter by items whose name is equally or lesser than a given input string. + List sortBy = Arrays.asList(); // List | Optional. Specify one or more sort orders, comma delimited. + List sortOrder = Arrays.asList(); // List | Sort Order - Ascending,Descending. + Boolean enableImages = true; // Boolean | Optional, include image information in output. + Boolean enableTotalRecordCount = true; // Boolean | Optional. Include total record count. + try { + BaseItemDtoQueryResult result = apiInstance.getGenres(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling GenresApi#getGenres"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **searchTerm** | **String**| The search term. | [optional] | +| **parentId** | **UUID**| Specify this to localize the search to a specific item or folder. Omit to use the root. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **excludeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. | [optional] | +| **includeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered in based on item type. This allows multiple, comma delimited. | [optional] | +| **isFavorite** | **Boolean**| Optional filter by items that are marked as favorite, or not. | [optional] | +| **imageTypeLimit** | **Integer**| Optional, the max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **userId** | **UUID**| 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] | +| **sortBy** | [**List<ItemSortBy>**](ItemSortBy.md)| Optional. Specify one or more sort orders, comma delimited. | [optional] | +| **sortOrder** | [**List<SortOrder>**](SortOrder.md)| Sort Order - Ascending,Descending. | [optional] | +| **enableImages** | **Boolean**| Optional, include image information in output. | [optional] [default to true] | +| **enableTotalRecordCount** | **Boolean**| Optional. Include total record count. | [optional] [default to true] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Genres returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GetProgramsDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GetProgramsDto.md new file mode 100644 index 0000000000000..6b08bcf5fbf99 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GetProgramsDto.md @@ -0,0 +1,40 @@ + + +# GetProgramsDto + +Get programs dto. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**channelIds** | **List<UUID>** | Gets or sets the channels to return guide information for. | [optional] | +|**userId** | **UUID** | Gets or sets optional. Filter by user id. | [optional] | +|**minStartDate** | **OffsetDateTime** | Gets or sets the minimum premiere start date. | [optional] | +|**hasAired** | **Boolean** | Gets or sets filter by programs that have completed airing, or not. | [optional] | +|**isAiring** | **Boolean** | Gets or sets filter by programs that are currently airing, or not. | [optional] | +|**maxStartDate** | **OffsetDateTime** | Gets or sets the maximum premiere start date. | [optional] | +|**minEndDate** | **OffsetDateTime** | Gets or sets the minimum premiere end date. | [optional] | +|**maxEndDate** | **OffsetDateTime** | Gets or sets the maximum premiere end date. | [optional] | +|**isMovie** | **Boolean** | Gets or sets filter for movies. | [optional] | +|**isSeries** | **Boolean** | Gets or sets filter for series. | [optional] | +|**isNews** | **Boolean** | Gets or sets filter for news. | [optional] | +|**isKids** | **Boolean** | Gets or sets filter for kids. | [optional] | +|**isSports** | **Boolean** | Gets or sets filter for sports. | [optional] | +|**startIndex** | **Integer** | Gets or sets the record index to start at. All items with a lower index will be dropped from the results. | [optional] | +|**limit** | **Integer** | Gets or sets the maximum number of records to return. | [optional] | +|**sortBy** | **List<ItemSortBy>** | Gets or sets specify one or more sort orders, comma delimited. Options: Name, StartDate. | [optional] | +|**sortOrder** | **List<SortOrder>** | Gets or sets sort order. | [optional] | +|**genres** | **List<String>** | Gets or sets the genres to return guide information for. | [optional] | +|**genreIds** | **List<UUID>** | Gets or sets the genre ids to return guide information for. | [optional] | +|**enableImages** | **Boolean** | Gets or sets include image information in output. | [optional] | +|**enableTotalRecordCount** | **Boolean** | Gets or sets a value indicating whether retrieve total record count. | [optional] | +|**imageTypeLimit** | **Integer** | Gets or sets the max number of images to return, per image type. | [optional] | +|**enableImageTypes** | **List<ImageType>** | Gets or sets the image types to include in the output. | [optional] | +|**enableUserData** | **Boolean** | Gets or sets include user data. | [optional] | +|**seriesTimerId** | **String** | Gets or sets filter by series timer id. | [optional] | +|**librarySeriesId** | **UUID** | Gets or sets filter by library series id. | [optional] | +|**fields** | **List<ItemFields>** | Gets or sets specify additional fields of information to return in the output. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GroupInfoDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupInfoDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GroupInfoDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupInfoDto.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupInfoDtoGroupUpdate.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupInfoDtoGroupUpdate.md new file mode 100644 index 0000000000000..b58664b8329fb --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupInfoDtoGroupUpdate.md @@ -0,0 +1,16 @@ + + +# GroupInfoDtoGroupUpdate + +Class GroupUpdate. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**groupId** | **UUID** | Gets the group identifier. | [optional] [readonly] | +|**type** | **GroupUpdateType** | Gets the update type. | [optional] | +|**data** | [**GroupInfoDto**](GroupInfoDto.md) | Gets the update data. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GroupQueueMode.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupQueueMode.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GroupQueueMode.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupQueueMode.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GroupRepeatMode.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupRepeatMode.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GroupRepeatMode.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupRepeatMode.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GroupShuffleMode.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupShuffleMode.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GroupShuffleMode.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupShuffleMode.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GroupStateType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupStateType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GroupStateType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupStateType.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupStateUpdate.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupStateUpdate.md new file mode 100644 index 0000000000000..22f8107ebeeb3 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupStateUpdate.md @@ -0,0 +1,15 @@ + + +# GroupStateUpdate + +Class GroupStateUpdate. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**state** | **GroupStateType** | Gets the state of the group. | [optional] | +|**reason** | **PlaybackRequestType** | Gets the reason of the state change. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupStateUpdateGroupUpdate.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupStateUpdateGroupUpdate.md new file mode 100644 index 0000000000000..9c177baebae95 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupStateUpdateGroupUpdate.md @@ -0,0 +1,16 @@ + + +# GroupStateUpdateGroupUpdate + +Class GroupUpdate. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**groupId** | **UUID** | Gets the group identifier. | [optional] [readonly] | +|**type** | **GroupUpdateType** | Gets the update type. | [optional] | +|**data** | [**GroupStateUpdate**](GroupStateUpdate.md) | Gets the update data. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupUpdate.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupUpdate.md new file mode 100644 index 0000000000000..8907877b33241 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupUpdate.md @@ -0,0 +1,16 @@ + + +# GroupUpdate + +Group update without data. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**groupId** | **UUID** | Gets the group identifier. | [optional] [readonly] | +|**type** | **GroupUpdateType** | Gets the update type. | [optional] | +|**data** | [**PlayQueueUpdate**](PlayQueueUpdate.md) | Gets the update data. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GroupUpdateType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupUpdateType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GroupUpdateType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GroupUpdateType.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GuideInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GuideInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/GuideInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/GuideInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/HardwareAccelerationType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/HardwareAccelerationType.md new file mode 100644 index 0000000000000..5dba0edb9cf12 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/HardwareAccelerationType.md @@ -0,0 +1,25 @@ + + +# HardwareAccelerationType + +## Enum + + +* `NONE` (value: `"none"`) + +* `AMF` (value: `"amf"`) + +* `QSV` (value: `"qsv"`) + +* `NVENC` (value: `"nvenc"`) + +* `V4L2M2M` (value: `"v4l2m2m"`) + +* `VAAPI` (value: `"vaapi"`) + +* `VIDEOTOOLBOX` (value: `"videotoolbox"`) + +* `RKMPP` (value: `"rkmpp"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/HlsSegmentApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/HlsSegmentApi.md new file mode 100644 index 0000000000000..c729c73a46496 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/HlsSegmentApi.md @@ -0,0 +1,345 @@ +# HlsSegmentApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getHlsAudioSegmentLegacyAac**](HlsSegmentApi.md#getHlsAudioSegmentLegacyAac) | **GET** /Audio/{itemId}/hls/{segmentId}/stream.aac | Gets the specified audio segment for an audio item. | +| [**getHlsAudioSegmentLegacyMp3**](HlsSegmentApi.md#getHlsAudioSegmentLegacyMp3) | **GET** /Audio/{itemId}/hls/{segmentId}/stream.mp3 | Gets the specified audio segment for an audio item. | +| [**getHlsPlaylistLegacy**](HlsSegmentApi.md#getHlsPlaylistLegacy) | **GET** /Videos/{itemId}/hls/{playlistId}/stream.m3u8 | Gets a hls video playlist. | +| [**getHlsVideoSegmentLegacy**](HlsSegmentApi.md#getHlsVideoSegmentLegacy) | **GET** /Videos/{itemId}/hls/{playlistId}/{segmentId}.{segmentContainer} | Gets a hls video segment. | +| [**stopEncodingProcess**](HlsSegmentApi.md#stopEncodingProcess) | **DELETE** /Videos/ActiveEncodings | Stops an active encoding. | + + + +# **getHlsAudioSegmentLegacyAac** +> File getHlsAudioSegmentLegacyAac(itemId, segmentId) + +Gets the specified audio segment for an audio item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.HlsSegmentApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + HlsSegmentApi apiInstance = new HlsSegmentApi(defaultClient); + String itemId = "itemId_example"; // String | The item id. + String segmentId = "segmentId_example"; // String | The segment id. + try { + File result = apiInstance.getHlsAudioSegmentLegacyAac(itemId, segmentId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling HlsSegmentApi#getHlsAudioSegmentLegacyAac"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **String**| The item id. | | +| **segmentId** | **String**| The segment id. | | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: audio/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Hls audio segment returned. | - | + + +# **getHlsAudioSegmentLegacyMp3** +> File getHlsAudioSegmentLegacyMp3(itemId, segmentId) + +Gets the specified audio segment for an audio item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.HlsSegmentApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + HlsSegmentApi apiInstance = new HlsSegmentApi(defaultClient); + String itemId = "itemId_example"; // String | The item id. + String segmentId = "segmentId_example"; // String | The segment id. + try { + File result = apiInstance.getHlsAudioSegmentLegacyMp3(itemId, segmentId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling HlsSegmentApi#getHlsAudioSegmentLegacyMp3"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **String**| The item id. | | +| **segmentId** | **String**| The segment id. | | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: audio/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Hls audio segment returned. | - | + + +# **getHlsPlaylistLegacy** +> File getHlsPlaylistLegacy(itemId, playlistId) + +Gets a hls video playlist. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.HlsSegmentApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + HlsSegmentApi apiInstance = new HlsSegmentApi(defaultClient); + String itemId = "itemId_example"; // String | The video id. + String playlistId = "playlistId_example"; // String | The playlist id. + try { + File result = apiInstance.getHlsPlaylistLegacy(itemId, playlistId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling HlsSegmentApi#getHlsPlaylistLegacy"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **String**| The video id. | | +| **playlistId** | **String**| The playlist id. | | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/x-mpegURL + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Hls video playlist returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getHlsVideoSegmentLegacy** +> File getHlsVideoSegmentLegacy(itemId, playlistId, segmentId, segmentContainer) + +Gets a hls video segment. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.HlsSegmentApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + HlsSegmentApi apiInstance = new HlsSegmentApi(defaultClient); + String itemId = "itemId_example"; // String | The item id. + String playlistId = "playlistId_example"; // String | The playlist id. + String segmentId = "segmentId_example"; // String | The segment id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + try { + File result = apiInstance.getHlsVideoSegmentLegacy(itemId, playlistId, segmentId, segmentContainer); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling HlsSegmentApi#getHlsVideoSegmentLegacy"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **String**| The item id. | | +| **playlistId** | **String**| The playlist id. | | +| **segmentId** | **String**| The segment id. | | +| **segmentContainer** | **String**| The segment container. | | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: video/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Hls video segment returned. | - | +| **404** | Hls segment not found. | - | + + +# **stopEncodingProcess** +> stopEncodingProcess(deviceId, playSessionId) + +Stops an active encoding. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.HlsSegmentApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + HlsSegmentApi apiInstance = new HlsSegmentApi(defaultClient); + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String playSessionId = "playSessionId_example"; // String | The play session id. + try { + apiInstance.stopEncodingProcess(deviceId, playSessionId); + } catch (ApiException e) { + System.err.println("Exception when calling HlsSegmentApi#stopEncodingProcess"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | | +| **playSessionId** | **String**| The play session id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Encoding stopped successfully. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/IPlugin.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/IPlugin.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/IPlugin.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/IPlugin.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/IgnoreWaitRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/IgnoreWaitRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/IgnoreWaitRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/IgnoreWaitRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageApi.md new file mode 100644 index 0000000000000..fe12fa2d51977 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageApi.md @@ -0,0 +1,3257 @@ +# ImageApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**deleteCustomSplashscreen**](ImageApi.md#deleteCustomSplashscreen) | **DELETE** /Branding/Splashscreen | Delete a custom splashscreen. | +| [**deleteItemImage**](ImageApi.md#deleteItemImage) | **DELETE** /Items/{itemId}/Images/{imageType} | Delete an item's image. | +| [**deleteItemImageByIndex**](ImageApi.md#deleteItemImageByIndex) | **DELETE** /Items/{itemId}/Images/{imageType}/{imageIndex} | Delete an item's image. | +| [**deleteUserImage**](ImageApi.md#deleteUserImage) | **DELETE** /UserImage | Delete the user's image. | +| [**getArtistImage**](ImageApi.md#getArtistImage) | **GET** /Artists/{name}/Images/{imageType}/{imageIndex} | Get artist image by name. | +| [**getGenreImage**](ImageApi.md#getGenreImage) | **GET** /Genres/{name}/Images/{imageType} | Get genre image by name. | +| [**getGenreImageByIndex**](ImageApi.md#getGenreImageByIndex) | **GET** /Genres/{name}/Images/{imageType}/{imageIndex} | Get genre image by name. | +| [**getItemImage**](ImageApi.md#getItemImage) | **GET** /Items/{itemId}/Images/{imageType} | Gets the item's image. | +| [**getItemImage2**](ImageApi.md#getItemImage2) | **GET** /Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount} | Gets the item's image. | +| [**getItemImageByIndex**](ImageApi.md#getItemImageByIndex) | **GET** /Items/{itemId}/Images/{imageType}/{imageIndex} | Gets the item's image. | +| [**getItemImageInfos**](ImageApi.md#getItemImageInfos) | **GET** /Items/{itemId}/Images | Get item image infos. | +| [**getMusicGenreImage**](ImageApi.md#getMusicGenreImage) | **GET** /MusicGenres/{name}/Images/{imageType} | Get music genre image by name. | +| [**getMusicGenreImageByIndex**](ImageApi.md#getMusicGenreImageByIndex) | **GET** /MusicGenres/{name}/Images/{imageType}/{imageIndex} | Get music genre image by name. | +| [**getPersonImage**](ImageApi.md#getPersonImage) | **GET** /Persons/{name}/Images/{imageType} | Get person image by name. | +| [**getPersonImageByIndex**](ImageApi.md#getPersonImageByIndex) | **GET** /Persons/{name}/Images/{imageType}/{imageIndex} | Get person image by name. | +| [**getSplashscreen**](ImageApi.md#getSplashscreen) | **GET** /Branding/Splashscreen | Generates or gets the splashscreen. | +| [**getStudioImage**](ImageApi.md#getStudioImage) | **GET** /Studios/{name}/Images/{imageType} | Get studio image by name. | +| [**getStudioImageByIndex**](ImageApi.md#getStudioImageByIndex) | **GET** /Studios/{name}/Images/{imageType}/{imageIndex} | Get studio image by name. | +| [**getUserImage**](ImageApi.md#getUserImage) | **GET** /UserImage | Get user profile image. | +| [**headArtistImage**](ImageApi.md#headArtistImage) | **HEAD** /Artists/{name}/Images/{imageType}/{imageIndex} | Get artist image by name. | +| [**headGenreImage**](ImageApi.md#headGenreImage) | **HEAD** /Genres/{name}/Images/{imageType} | Get genre image by name. | +| [**headGenreImageByIndex**](ImageApi.md#headGenreImageByIndex) | **HEAD** /Genres/{name}/Images/{imageType}/{imageIndex} | Get genre image by name. | +| [**headItemImage**](ImageApi.md#headItemImage) | **HEAD** /Items/{itemId}/Images/{imageType} | Gets the item's image. | +| [**headItemImage2**](ImageApi.md#headItemImage2) | **HEAD** /Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount} | Gets the item's image. | +| [**headItemImageByIndex**](ImageApi.md#headItemImageByIndex) | **HEAD** /Items/{itemId}/Images/{imageType}/{imageIndex} | Gets the item's image. | +| [**headMusicGenreImage**](ImageApi.md#headMusicGenreImage) | **HEAD** /MusicGenres/{name}/Images/{imageType} | Get music genre image by name. | +| [**headMusicGenreImageByIndex**](ImageApi.md#headMusicGenreImageByIndex) | **HEAD** /MusicGenres/{name}/Images/{imageType}/{imageIndex} | Get music genre image by name. | +| [**headPersonImage**](ImageApi.md#headPersonImage) | **HEAD** /Persons/{name}/Images/{imageType} | Get person image by name. | +| [**headPersonImageByIndex**](ImageApi.md#headPersonImageByIndex) | **HEAD** /Persons/{name}/Images/{imageType}/{imageIndex} | Get person image by name. | +| [**headStudioImage**](ImageApi.md#headStudioImage) | **HEAD** /Studios/{name}/Images/{imageType} | Get studio image by name. | +| [**headStudioImageByIndex**](ImageApi.md#headStudioImageByIndex) | **HEAD** /Studios/{name}/Images/{imageType}/{imageIndex} | Get studio image by name. | +| [**headUserImage**](ImageApi.md#headUserImage) | **HEAD** /UserImage | Get user profile image. | +| [**postUserImage**](ImageApi.md#postUserImage) | **POST** /UserImage | Sets the user image. | +| [**setItemImage**](ImageApi.md#setItemImage) | **POST** /Items/{itemId}/Images/{imageType} | Set item image. | +| [**setItemImageByIndex**](ImageApi.md#setItemImageByIndex) | **POST** /Items/{itemId}/Images/{imageType}/{imageIndex} | Set item image. | +| [**updateItemImageIndex**](ImageApi.md#updateItemImageIndex) | **POST** /Items/{itemId}/Images/{imageType}/{imageIndex}/Index | Updates the index for an item image. | +| [**uploadCustomSplashscreen**](ImageApi.md#uploadCustomSplashscreen) | **POST** /Branding/Splashscreen | Uploads a custom splashscreen. The body is expected to the image contents base64 encoded. | + + + +# **deleteCustomSplashscreen** +> deleteCustomSplashscreen() + +Delete a custom splashscreen. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ImageApi apiInstance = new ImageApi(defaultClient); + try { + apiInstance.deleteCustomSplashscreen(); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#deleteCustomSplashscreen"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Successfully deleted the custom splashscreen. | - | +| **403** | User does not have permission to delete splashscreen.. | - | +| **401** | Unauthorized | - | + + +# **deleteItemImage** +> deleteItemImage(itemId, imageType, imageIndex) + +Delete an item's image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | The image index. + try { + apiInstance.deleteItemImage(itemId, imageType, imageIndex); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#deleteItemImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| The image index. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Image deleted. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **deleteItemImageByIndex** +> deleteItemImageByIndex(itemId, imageType, imageIndex) + +Delete an item's image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | The image index. + try { + apiInstance.deleteItemImageByIndex(itemId, imageType, imageIndex); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#deleteItemImageByIndex"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| The image index. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Image deleted. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **deleteUserImage** +> deleteUserImage(userId) + +Delete the user's image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | User Id. + try { + apiInstance.deleteUserImage(userId); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#deleteUserImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| User Id. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Image deleted. | - | +| **403** | User does not have permission to delete the image. | - | +| **401** | Unauthorized | - | + + +# **getArtistImage** +> File getArtistImage(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer) + +Get artist image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Artist name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | Image index. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + try { + File result = apiInstance.getArtistImage(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#getArtistImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Artist name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| Image index. | | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **getGenreImage** +> File getGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex) + +Get genre image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Genre name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + Integer imageIndex = 56; // Integer | Image index. + try { + File result = apiInstance.getGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#getGenreImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Genre name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | +| **imageIndex** | **Integer**| Image index. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **getGenreImageByIndex** +> File getGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer) + +Get genre image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Genre name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | Image index. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + try { + File result = apiInstance.getGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#getGenreImageByIndex"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Genre name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| Image index. | | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **getItemImage** +> File getItemImage(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex) + +Gets the item's image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + Integer imageIndex = 56; // Integer | Image index. + try { + File result = apiInstance.getItemImage(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#getItemImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | +| **imageIndex** | **Integer**| Image index. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **getItemImage2** +> File getItemImage2(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer) + +Gets the item's image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer imageIndex = 56; // Integer | Image index. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + try { + File result = apiInstance.getItemImage2(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#getItemImage2"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **maxWidth** | **Integer**| The maximum image width to return. | | +| **maxHeight** | **Integer**| The maximum image height to return. | | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | | +| **imageIndex** | **Integer**| Image index. | | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **getItemImageByIndex** +> File getItemImageByIndex(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer) + +Gets the item's image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | Image index. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + try { + File result = apiInstance.getItemImageByIndex(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#getItemImageByIndex"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| Image index. | | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **getItemImageInfos** +> List<ImageInfo> getItemImageInfos(itemId) + +Get item image infos. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + try { + List result = apiInstance.getItemImageInfos(itemId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#getItemImageInfos"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | + +### Return type + +[**List<ImageInfo>**](ImageInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Item images returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getMusicGenreImage** +> File getMusicGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex) + +Get music genre image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Music genre name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + Integer imageIndex = 56; // Integer | Image index. + try { + File result = apiInstance.getMusicGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#getMusicGenreImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Music genre name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | +| **imageIndex** | **Integer**| Image index. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **getMusicGenreImageByIndex** +> File getMusicGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer) + +Get music genre image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Music genre name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | Image index. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + try { + File result = apiInstance.getMusicGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#getMusicGenreImageByIndex"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Music genre name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| Image index. | | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **getPersonImage** +> File getPersonImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex) + +Get person image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Person name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + Integer imageIndex = 56; // Integer | Image index. + try { + File result = apiInstance.getPersonImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#getPersonImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Person name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | +| **imageIndex** | **Integer**| Image index. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **getPersonImageByIndex** +> File getPersonImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer) + +Get person image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Person name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | Image index. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + try { + File result = apiInstance.getPersonImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#getPersonImageByIndex"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Person name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| Image index. | | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **getSplashscreen** +> File getSplashscreen(tag, format, maxWidth, maxHeight, width, height, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, quality) + +Generates or gets the splashscreen. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String tag = "tag_example"; // String | Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Blur image. + String backgroundColor = "backgroundColor_example"; // String | Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Apply a foreground layer on top of the image. + Integer quality = 90; // Integer | Quality setting, from 0-100. + try { + File result = apiInstance.getSplashscreen(tag, format, maxWidth, maxHeight, width, height, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, quality); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#getSplashscreen"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **tag** | **String**| Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Blur image. | [optional] | +| **backgroundColor** | **String**| Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Apply a foreground layer on top of the image. | [optional] | +| **quality** | **Integer**| Quality setting, from 0-100. | [optional] [default to 90] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Splashscreen returned successfully. | - | + + +# **getStudioImage** +> File getStudioImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex) + +Get studio image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Studio name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + Integer imageIndex = 56; // Integer | Image index. + try { + File result = apiInstance.getStudioImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#getStudioImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Studio name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | +| **imageIndex** | **Integer**| Image index. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **getStudioImageByIndex** +> File getStudioImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer) + +Get studio image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Studio name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | Image index. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + try { + File result = apiInstance.getStudioImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#getStudioImageByIndex"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Studio name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| Image index. | | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **getUserImage** +> File getUserImage(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex) + +Get user profile image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | User id. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + Integer imageIndex = 56; // Integer | Image index. + try { + File result = apiInstance.getUserImage(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#getUserImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| User id. | [optional] | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | +| **imageIndex** | **Integer**| Image index. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **400** | User id not provided. | - | +| **404** | Item not found. | - | + + +# **headArtistImage** +> File headArtistImage(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer) + +Get artist image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Artist name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | Image index. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + try { + File result = apiInstance.headArtistImage(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#headArtistImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Artist name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| Image index. | | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **headGenreImage** +> File headGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex) + +Get genre image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Genre name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + Integer imageIndex = 56; // Integer | Image index. + try { + File result = apiInstance.headGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#headGenreImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Genre name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | +| **imageIndex** | **Integer**| Image index. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **headGenreImageByIndex** +> File headGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer) + +Get genre image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Genre name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | Image index. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + try { + File result = apiInstance.headGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#headGenreImageByIndex"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Genre name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| Image index. | | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **headItemImage** +> File headItemImage(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex) + +Gets the item's image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + Integer imageIndex = 56; // Integer | Image index. + try { + File result = apiInstance.headItemImage(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#headItemImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | +| **imageIndex** | **Integer**| Image index. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **headItemImage2** +> File headItemImage2(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer) + +Gets the item's image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer imageIndex = 56; // Integer | Image index. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + try { + File result = apiInstance.headItemImage2(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#headItemImage2"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **maxWidth** | **Integer**| The maximum image width to return. | | +| **maxHeight** | **Integer**| The maximum image height to return. | | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | | +| **imageIndex** | **Integer**| Image index. | | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **headItemImageByIndex** +> File headItemImageByIndex(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer) + +Gets the item's image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | Image index. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + try { + File result = apiInstance.headItemImageByIndex(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#headItemImageByIndex"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| Image index. | | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **headMusicGenreImage** +> File headMusicGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex) + +Get music genre image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Music genre name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + Integer imageIndex = 56; // Integer | Image index. + try { + File result = apiInstance.headMusicGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#headMusicGenreImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Music genre name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | +| **imageIndex** | **Integer**| Image index. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **headMusicGenreImageByIndex** +> File headMusicGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer) + +Get music genre image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Music genre name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | Image index. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + try { + File result = apiInstance.headMusicGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#headMusicGenreImageByIndex"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Music genre name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| Image index. | | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **headPersonImage** +> File headPersonImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex) + +Get person image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Person name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + Integer imageIndex = 56; // Integer | Image index. + try { + File result = apiInstance.headPersonImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#headPersonImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Person name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | +| **imageIndex** | **Integer**| Image index. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **headPersonImageByIndex** +> File headPersonImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer) + +Get person image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Person name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | Image index. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + try { + File result = apiInstance.headPersonImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#headPersonImageByIndex"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Person name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| Image index. | | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **headStudioImage** +> File headStudioImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex) + +Get studio image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Studio name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + Integer imageIndex = 56; // Integer | Image index. + try { + File result = apiInstance.headStudioImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#headStudioImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Studio name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | +| **imageIndex** | **Integer**| Image index. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **headStudioImageByIndex** +> File headStudioImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer) + +Get studio image by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + String name = "name_example"; // String | Studio name. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | Image index. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + try { + File result = apiInstance.headStudioImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#headStudioImageByIndex"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Studio name. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| Image index. | | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **404** | Item not found. | - | + + +# **headUserImage** +> File headUserImage(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex) + +Get user profile image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | User id. + String tag = "tag_example"; // String | Optional. Supply the cache tag from the item object to receive strong caching headers. + ImageFormat format = ImageFormat.fromValue("Bmp"); // ImageFormat | Determines the output format of the image - original,gif,jpg,png. + Integer maxWidth = 56; // Integer | The maximum image width to return. + Integer maxHeight = 56; // Integer | The maximum image height to return. + Double percentPlayed = 3.4D; // Double | Optional. Percent to render for the percent played overlay. + Integer unplayedCount = 56; // Integer | Optional. Unplayed count overlay to render. + Integer width = 56; // Integer | The fixed image width to return. + Integer height = 56; // Integer | The fixed image height to return. + Integer quality = 56; // Integer | Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. + Integer fillWidth = 56; // Integer | Width of box to fill. + Integer fillHeight = 56; // Integer | Height of box to fill. + Integer blur = 56; // Integer | Optional. Blur image. + String backgroundColor = "backgroundColor_example"; // String | Optional. Apply a background color for transparent images. + String foregroundLayer = "foregroundLayer_example"; // String | Optional. Apply a foreground layer on top of the image. + Integer imageIndex = 56; // Integer | Image index. + try { + File result = apiInstance.headUserImage(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#headUserImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| User id. | [optional] | +| **tag** | **String**| Optional. Supply the cache tag from the item object to receive strong caching headers. | [optional] | +| **format** | **ImageFormat**| Determines the output format of the image - original,gif,jpg,png. | [optional] [enum: Bmp, Gif, Jpg, Png, Webp, Svg] | +| **maxWidth** | **Integer**| The maximum image width to return. | [optional] | +| **maxHeight** | **Integer**| The maximum image height to return. | [optional] | +| **percentPlayed** | **Double**| Optional. Percent to render for the percent played overlay. | [optional] | +| **unplayedCount** | **Integer**| Optional. Unplayed count overlay to render. | [optional] | +| **width** | **Integer**| The fixed image width to return. | [optional] | +| **height** | **Integer**| The fixed image height to return. | [optional] | +| **quality** | **Integer**| Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. | [optional] | +| **fillWidth** | **Integer**| Width of box to fill. | [optional] | +| **fillHeight** | **Integer**| Height of box to fill. | [optional] | +| **blur** | **Integer**| Optional. Blur image. | [optional] | +| **backgroundColor** | **String**| Optional. Apply a background color for transparent images. | [optional] | +| **foregroundLayer** | **String**| Optional. Apply a foreground layer on top of the image. | [optional] | +| **imageIndex** | **Integer**| Image index. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Image stream returned. | - | +| **400** | User id not provided. | - | +| **404** | Item not found. | - | + + +# **postUserImage** +> postUserImage(userId, body) + +Sets the user image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | User Id. + File body = new File("/path/to/file"); // File | + try { + apiInstance.postUserImage(userId, body); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#postUserImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| User Id. | [optional] | +| **body** | **File**| | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: image/* + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Image updated. | - | +| **400** | Bad Request | - | +| **403** | User does not have permission to delete the image. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | + + +# **setItemImage** +> setItemImage(itemId, imageType, body) + +Set item image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + File body = new File("/path/to/file"); // File | + try { + apiInstance.setItemImage(itemId, imageType, body); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#setItemImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **body** | **File**| | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: image/* + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Image saved. | - | +| **400** | Bad Request | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **setItemImageByIndex** +> setItemImageByIndex(itemId, imageType, imageIndex, body) + +Set item image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | (Unused) Image index. + File body = new File("/path/to/file"); // File | + try { + apiInstance.setItemImageByIndex(itemId, imageType, imageIndex, body); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#setItemImageByIndex"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| (Unused) Image index. | | +| **body** | **File**| | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: image/* + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Image saved. | - | +| **400** | Bad Request | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateItemImageIndex** +> updateItemImageIndex(itemId, imageType, imageIndex, newIndex) + +Updates the index for an item image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ImageApi apiInstance = new ImageApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + ImageType imageType = ImageType.fromValue("Primary"); // ImageType | Image type. + Integer imageIndex = 56; // Integer | Old image index. + Integer newIndex = 56; // Integer | New image index. + try { + apiInstance.updateItemImageIndex(itemId, imageType, imageIndex, newIndex); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#updateItemImageIndex"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **imageType** | **ImageType**| Image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageIndex** | **Integer**| Old image index. | | +| **newIndex** | **Integer**| New image index. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Image index updated. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **uploadCustomSplashscreen** +> uploadCustomSplashscreen(body) + +Uploads a custom splashscreen. The body is expected to the image contents base64 encoded. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ImageApi apiInstance = new ImageApi(defaultClient); + File body = new File("/path/to/file"); // File | + try { + apiInstance.uploadCustomSplashscreen(body); + } catch (ApiException e) { + System.err.println("Exception when calling ImageApi#uploadCustomSplashscreen"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **body** | **File**| | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: image/* + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Successfully uploaded new splashscreen. | - | +| **400** | Error reading MimeType from uploaded image. | - | +| **403** | User does not have permission to upload splashscreen.. | - | +| **401** | Unauthorized | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/ImageFormat.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageFormat.md similarity index 86% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/ImageFormat.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageFormat.md index 0c3909383c361..d4aacfa8ab684 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/ImageFormat.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageFormat.md @@ -15,5 +15,7 @@ * `WEBP` (value: `"Webp"`) +* `SVG` (value: `"Svg"`) + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ImageInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ImageInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ImageOption.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageOption.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ImageOption.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageOption.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ImageOrientation.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageOrientation.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ImageOrientation.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageOrientation.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ImageProviderInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageProviderInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ImageProviderInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageProviderInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageResolution.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageResolution.md new file mode 100644 index 0000000000000..07861a96b3e4b --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageResolution.md @@ -0,0 +1,27 @@ + + +# ImageResolution + +## Enum + + +* `MATCH_SOURCE` (value: `"MatchSource"`) + +* `P144` (value: `"P144"`) + +* `P240` (value: `"P240"`) + +* `P360` (value: `"P360"`) + +* `P480` (value: `"P480"`) + +* `P720` (value: `"P720"`) + +* `P1080` (value: `"P1080"`) + +* `P1440` (value: `"P1440"`) + +* `P2160` (value: `"P2160"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ImageSavingConvention.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageSavingConvention.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ImageSavingConvention.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageSavingConvention.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ImageType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ImageType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ImageType.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/InboundKeepAliveMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/InboundKeepAliveMessage.md new file mode 100644 index 0000000000000..54af2fe5f3a53 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/InboundKeepAliveMessage.md @@ -0,0 +1,14 @@ + + +# InboundKeepAliveMessage + +Keep alive websocket messages. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/InboundWebSocketMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/InboundWebSocketMessage.md new file mode 100644 index 0000000000000..2051e945b0897 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/InboundWebSocketMessage.md @@ -0,0 +1,15 @@ + + +# InboundWebSocketMessage + +Represents the list of possible inbound websocket types + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | **String** | Gets or sets the data. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/InstallationInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/InstallationInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/InstallationInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/InstallationInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/InstantMixApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/InstantMixApi.md new file mode 100644 index 0000000000000..ca877a00fb351 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/InstantMixApi.md @@ -0,0 +1,687 @@ +# InstantMixApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getInstantMixFromAlbum**](InstantMixApi.md#getInstantMixFromAlbum) | **GET** /Albums/{itemId}/InstantMix | Creates an instant playlist based on a given album. | +| [**getInstantMixFromArtists**](InstantMixApi.md#getInstantMixFromArtists) | **GET** /Artists/{itemId}/InstantMix | Creates an instant playlist based on a given artist. | +| [**getInstantMixFromArtists2**](InstantMixApi.md#getInstantMixFromArtists2) | **GET** /Artists/InstantMix | Creates an instant playlist based on a given artist. | +| [**getInstantMixFromItem**](InstantMixApi.md#getInstantMixFromItem) | **GET** /Items/{itemId}/InstantMix | Creates an instant playlist based on a given item. | +| [**getInstantMixFromMusicGenreById**](InstantMixApi.md#getInstantMixFromMusicGenreById) | **GET** /MusicGenres/InstantMix | Creates an instant playlist based on a given genre. | +| [**getInstantMixFromMusicGenreByName**](InstantMixApi.md#getInstantMixFromMusicGenreByName) | **GET** /MusicGenres/{name}/InstantMix | Creates an instant playlist based on a given genre. | +| [**getInstantMixFromPlaylist**](InstantMixApi.md#getInstantMixFromPlaylist) | **GET** /Playlists/{itemId}/InstantMix | Creates an instant playlist based on a given playlist. | +| [**getInstantMixFromSong**](InstantMixApi.md#getInstantMixFromSong) | **GET** /Songs/{itemId}/InstantMix | Creates an instant playlist based on a given song. | + + + +# **getInstantMixFromAlbum** +> BaseItemDtoQueryResult getInstantMixFromAlbum(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes) + +Creates an instant playlist based on a given album. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.InstantMixApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + InstantMixApi apiInstance = new InstantMixApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + try { + BaseItemDtoQueryResult result = apiInstance.getInstantMixFromAlbum(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling InstantMixApi#getInstantMixFromAlbum"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Instant playlist returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getInstantMixFromArtists** +> BaseItemDtoQueryResult getInstantMixFromArtists(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes) + +Creates an instant playlist based on a given artist. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.InstantMixApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + InstantMixApi apiInstance = new InstantMixApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + try { + BaseItemDtoQueryResult result = apiInstance.getInstantMixFromArtists(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling InstantMixApi#getInstantMixFromArtists"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Instant playlist returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getInstantMixFromArtists2** +> BaseItemDtoQueryResult getInstantMixFromArtists2(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes) + +Creates an instant playlist based on a given artist. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.InstantMixApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + InstantMixApi apiInstance = new InstantMixApi(defaultClient); + UUID id = UUID.randomUUID(); // UUID | The item id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + try { + BaseItemDtoQueryResult result = apiInstance.getInstantMixFromArtists2(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling InstantMixApi#getInstantMixFromArtists2"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **id** | **UUID**| The item id. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Instant playlist returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getInstantMixFromItem** +> BaseItemDtoQueryResult getInstantMixFromItem(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes) + +Creates an instant playlist based on a given item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.InstantMixApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + InstantMixApi apiInstance = new InstantMixApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + try { + BaseItemDtoQueryResult result = apiInstance.getInstantMixFromItem(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling InstantMixApi#getInstantMixFromItem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Instant playlist returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getInstantMixFromMusicGenreById** +> BaseItemDtoQueryResult getInstantMixFromMusicGenreById(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes) + +Creates an instant playlist based on a given genre. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.InstantMixApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + InstantMixApi apiInstance = new InstantMixApi(defaultClient); + UUID id = UUID.randomUUID(); // UUID | The item id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + try { + BaseItemDtoQueryResult result = apiInstance.getInstantMixFromMusicGenreById(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling InstantMixApi#getInstantMixFromMusicGenreById"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **id** | **UUID**| The item id. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Instant playlist returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getInstantMixFromMusicGenreByName** +> BaseItemDtoQueryResult getInstantMixFromMusicGenreByName(name, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes) + +Creates an instant playlist based on a given genre. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.InstantMixApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + InstantMixApi apiInstance = new InstantMixApi(defaultClient); + String name = "name_example"; // String | The genre name. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + try { + BaseItemDtoQueryResult result = apiInstance.getInstantMixFromMusicGenreByName(name, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling InstantMixApi#getInstantMixFromMusicGenreByName"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| The genre name. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Instant playlist returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getInstantMixFromPlaylist** +> BaseItemDtoQueryResult getInstantMixFromPlaylist(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes) + +Creates an instant playlist based on a given playlist. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.InstantMixApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + InstantMixApi apiInstance = new InstantMixApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + try { + BaseItemDtoQueryResult result = apiInstance.getInstantMixFromPlaylist(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling InstantMixApi#getInstantMixFromPlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Instant playlist returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getInstantMixFromSong** +> BaseItemDtoQueryResult getInstantMixFromSong(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes) + +Creates an instant playlist based on a given song. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.InstantMixApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + InstantMixApi apiInstance = new InstantMixApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + try { + BaseItemDtoQueryResult result = apiInstance.getInstantMixFromSong(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling InstantMixApi#getInstantMixFromSong"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Instant playlist returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/IsoType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/IsoType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/IsoType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/IsoType.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ItemCounts.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemCounts.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ItemCounts.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemCounts.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/ItemFields.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemFields.md similarity index 97% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/ItemFields.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemFields.md index ba132967f120c..98f007d9b30f6 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/ItemFields.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemFields.md @@ -15,6 +15,8 @@ * `CHAPTERS` (value: `"Chapters"`) +* `TRICKPLAY` (value: `"Trickplay"`) + * `CHILD_COUNT` (value: `"ChildCount"`) * `CUMULATIVE_RUN_TIME_TICKS` (value: `"CumulativeRunTimeTicks"`) @@ -75,10 +77,6 @@ * `STUDIOS` (value: `"Studios"`) -* `BASIC_SYNC_INFO` (value: `"BasicSyncInfo"`) - -* `SYNC_INFO` (value: `"SyncInfo"`) - * `TAGLINES` (value: `"Taglines"`) * `TAGS` (value: `"Tags"`) diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ItemFilter.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemFilter.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ItemFilter.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemFilter.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemLookupApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemLookupApi.md new file mode 100644 index 0000000000000..fbee1b88289c3 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemLookupApi.md @@ -0,0 +1,783 @@ +# ItemLookupApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**applySearchCriteria**](ItemLookupApi.md#applySearchCriteria) | **POST** /Items/RemoteSearch/Apply/{itemId} | Applies search criteria to an item and refreshes metadata. | +| [**getBookRemoteSearchResults**](ItemLookupApi.md#getBookRemoteSearchResults) | **POST** /Items/RemoteSearch/Book | Get book remote search. | +| [**getBoxSetRemoteSearchResults**](ItemLookupApi.md#getBoxSetRemoteSearchResults) | **POST** /Items/RemoteSearch/BoxSet | Get box set remote search. | +| [**getExternalIdInfos**](ItemLookupApi.md#getExternalIdInfos) | **GET** /Items/{itemId}/ExternalIdInfos | Get the item's external id info. | +| [**getMovieRemoteSearchResults**](ItemLookupApi.md#getMovieRemoteSearchResults) | **POST** /Items/RemoteSearch/Movie | Get movie remote search. | +| [**getMusicAlbumRemoteSearchResults**](ItemLookupApi.md#getMusicAlbumRemoteSearchResults) | **POST** /Items/RemoteSearch/MusicAlbum | Get music album remote search. | +| [**getMusicArtistRemoteSearchResults**](ItemLookupApi.md#getMusicArtistRemoteSearchResults) | **POST** /Items/RemoteSearch/MusicArtist | Get music artist remote search. | +| [**getMusicVideoRemoteSearchResults**](ItemLookupApi.md#getMusicVideoRemoteSearchResults) | **POST** /Items/RemoteSearch/MusicVideo | Get music video remote search. | +| [**getPersonRemoteSearchResults**](ItemLookupApi.md#getPersonRemoteSearchResults) | **POST** /Items/RemoteSearch/Person | Get person remote search. | +| [**getSeriesRemoteSearchResults**](ItemLookupApi.md#getSeriesRemoteSearchResults) | **POST** /Items/RemoteSearch/Series | Get series remote search. | +| [**getTrailerRemoteSearchResults**](ItemLookupApi.md#getTrailerRemoteSearchResults) | **POST** /Items/RemoteSearch/Trailer | Get trailer remote search. | + + + +# **applySearchCriteria** +> applySearchCriteria(itemId, remoteSearchResult, replaceAllImages) + +Applies search criteria to an item and refreshes metadata. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemLookupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemLookupApi apiInstance = new ItemLookupApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + RemoteSearchResult remoteSearchResult = new RemoteSearchResult(); // RemoteSearchResult | The remote search result. + Boolean replaceAllImages = true; // Boolean | Optional. Whether or not to replace all images. Default: True. + try { + apiInstance.applySearchCriteria(itemId, remoteSearchResult, replaceAllImages); + } catch (ApiException e) { + System.err.println("Exception when calling ItemLookupApi#applySearchCriteria"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **remoteSearchResult** | [**RemoteSearchResult**](RemoteSearchResult.md)| The remote search result. | | +| **replaceAllImages** | **Boolean**| Optional. Whether or not to replace all images. Default: True. | [optional] [default to true] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Item metadata refreshed. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getBookRemoteSearchResults** +> List<RemoteSearchResult> getBookRemoteSearchResults(bookInfoRemoteSearchQuery) + +Get book remote search. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemLookupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemLookupApi apiInstance = new ItemLookupApi(defaultClient); + BookInfoRemoteSearchQuery bookInfoRemoteSearchQuery = new BookInfoRemoteSearchQuery(); // BookInfoRemoteSearchQuery | Remote search query. + try { + List result = apiInstance.getBookRemoteSearchResults(bookInfoRemoteSearchQuery); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ItemLookupApi#getBookRemoteSearchResults"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **bookInfoRemoteSearchQuery** | [**BookInfoRemoteSearchQuery**](BookInfoRemoteSearchQuery.md)| Remote search query. | | + +### Return type + +[**List<RemoteSearchResult>**](RemoteSearchResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Book remote search executed. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getBoxSetRemoteSearchResults** +> List<RemoteSearchResult> getBoxSetRemoteSearchResults(boxSetInfoRemoteSearchQuery) + +Get box set remote search. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemLookupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemLookupApi apiInstance = new ItemLookupApi(defaultClient); + BoxSetInfoRemoteSearchQuery boxSetInfoRemoteSearchQuery = new BoxSetInfoRemoteSearchQuery(); // BoxSetInfoRemoteSearchQuery | Remote search query. + try { + List result = apiInstance.getBoxSetRemoteSearchResults(boxSetInfoRemoteSearchQuery); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ItemLookupApi#getBoxSetRemoteSearchResults"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **boxSetInfoRemoteSearchQuery** | [**BoxSetInfoRemoteSearchQuery**](BoxSetInfoRemoteSearchQuery.md)| Remote search query. | | + +### Return type + +[**List<RemoteSearchResult>**](RemoteSearchResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Box set remote search executed. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getExternalIdInfos** +> List<ExternalIdInfo> getExternalIdInfos(itemId) + +Get the item's external id info. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemLookupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemLookupApi apiInstance = new ItemLookupApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + try { + List result = apiInstance.getExternalIdInfos(itemId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ItemLookupApi#getExternalIdInfos"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | + +### Return type + +[**List<ExternalIdInfo>**](ExternalIdInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | External id info retrieved. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getMovieRemoteSearchResults** +> List<RemoteSearchResult> getMovieRemoteSearchResults(movieInfoRemoteSearchQuery) + +Get movie remote search. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemLookupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemLookupApi apiInstance = new ItemLookupApi(defaultClient); + MovieInfoRemoteSearchQuery movieInfoRemoteSearchQuery = new MovieInfoRemoteSearchQuery(); // MovieInfoRemoteSearchQuery | Remote search query. + try { + List result = apiInstance.getMovieRemoteSearchResults(movieInfoRemoteSearchQuery); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ItemLookupApi#getMovieRemoteSearchResults"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **movieInfoRemoteSearchQuery** | [**MovieInfoRemoteSearchQuery**](MovieInfoRemoteSearchQuery.md)| Remote search query. | | + +### Return type + +[**List<RemoteSearchResult>**](RemoteSearchResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Movie remote search executed. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getMusicAlbumRemoteSearchResults** +> List<RemoteSearchResult> getMusicAlbumRemoteSearchResults(albumInfoRemoteSearchQuery) + +Get music album remote search. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemLookupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemLookupApi apiInstance = new ItemLookupApi(defaultClient); + AlbumInfoRemoteSearchQuery albumInfoRemoteSearchQuery = new AlbumInfoRemoteSearchQuery(); // AlbumInfoRemoteSearchQuery | Remote search query. + try { + List result = apiInstance.getMusicAlbumRemoteSearchResults(albumInfoRemoteSearchQuery); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ItemLookupApi#getMusicAlbumRemoteSearchResults"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **albumInfoRemoteSearchQuery** | [**AlbumInfoRemoteSearchQuery**](AlbumInfoRemoteSearchQuery.md)| Remote search query. | | + +### Return type + +[**List<RemoteSearchResult>**](RemoteSearchResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Music album remote search executed. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getMusicArtistRemoteSearchResults** +> List<RemoteSearchResult> getMusicArtistRemoteSearchResults(artistInfoRemoteSearchQuery) + +Get music artist remote search. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemLookupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemLookupApi apiInstance = new ItemLookupApi(defaultClient); + ArtistInfoRemoteSearchQuery artistInfoRemoteSearchQuery = new ArtistInfoRemoteSearchQuery(); // ArtistInfoRemoteSearchQuery | Remote search query. + try { + List result = apiInstance.getMusicArtistRemoteSearchResults(artistInfoRemoteSearchQuery); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ItemLookupApi#getMusicArtistRemoteSearchResults"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **artistInfoRemoteSearchQuery** | [**ArtistInfoRemoteSearchQuery**](ArtistInfoRemoteSearchQuery.md)| Remote search query. | | + +### Return type + +[**List<RemoteSearchResult>**](RemoteSearchResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Music artist remote search executed. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getMusicVideoRemoteSearchResults** +> List<RemoteSearchResult> getMusicVideoRemoteSearchResults(musicVideoInfoRemoteSearchQuery) + +Get music video remote search. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemLookupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemLookupApi apiInstance = new ItemLookupApi(defaultClient); + MusicVideoInfoRemoteSearchQuery musicVideoInfoRemoteSearchQuery = new MusicVideoInfoRemoteSearchQuery(); // MusicVideoInfoRemoteSearchQuery | Remote search query. + try { + List result = apiInstance.getMusicVideoRemoteSearchResults(musicVideoInfoRemoteSearchQuery); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ItemLookupApi#getMusicVideoRemoteSearchResults"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **musicVideoInfoRemoteSearchQuery** | [**MusicVideoInfoRemoteSearchQuery**](MusicVideoInfoRemoteSearchQuery.md)| Remote search query. | | + +### Return type + +[**List<RemoteSearchResult>**](RemoteSearchResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Music video remote search executed. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPersonRemoteSearchResults** +> List<RemoteSearchResult> getPersonRemoteSearchResults(personLookupInfoRemoteSearchQuery) + +Get person remote search. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemLookupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemLookupApi apiInstance = new ItemLookupApi(defaultClient); + PersonLookupInfoRemoteSearchQuery personLookupInfoRemoteSearchQuery = new PersonLookupInfoRemoteSearchQuery(); // PersonLookupInfoRemoteSearchQuery | Remote search query. + try { + List result = apiInstance.getPersonRemoteSearchResults(personLookupInfoRemoteSearchQuery); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ItemLookupApi#getPersonRemoteSearchResults"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **personLookupInfoRemoteSearchQuery** | [**PersonLookupInfoRemoteSearchQuery**](PersonLookupInfoRemoteSearchQuery.md)| Remote search query. | | + +### Return type + +[**List<RemoteSearchResult>**](RemoteSearchResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Person remote search executed. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getSeriesRemoteSearchResults** +> List<RemoteSearchResult> getSeriesRemoteSearchResults(seriesInfoRemoteSearchQuery) + +Get series remote search. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemLookupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemLookupApi apiInstance = new ItemLookupApi(defaultClient); + SeriesInfoRemoteSearchQuery seriesInfoRemoteSearchQuery = new SeriesInfoRemoteSearchQuery(); // SeriesInfoRemoteSearchQuery | Remote search query. + try { + List result = apiInstance.getSeriesRemoteSearchResults(seriesInfoRemoteSearchQuery); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ItemLookupApi#getSeriesRemoteSearchResults"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **seriesInfoRemoteSearchQuery** | [**SeriesInfoRemoteSearchQuery**](SeriesInfoRemoteSearchQuery.md)| Remote search query. | | + +### Return type + +[**List<RemoteSearchResult>**](RemoteSearchResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Series remote search executed. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getTrailerRemoteSearchResults** +> List<RemoteSearchResult> getTrailerRemoteSearchResults(trailerInfoRemoteSearchQuery) + +Get trailer remote search. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemLookupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemLookupApi apiInstance = new ItemLookupApi(defaultClient); + TrailerInfoRemoteSearchQuery trailerInfoRemoteSearchQuery = new TrailerInfoRemoteSearchQuery(); // TrailerInfoRemoteSearchQuery | Remote search query. + try { + List result = apiInstance.getTrailerRemoteSearchResults(trailerInfoRemoteSearchQuery); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ItemLookupApi#getTrailerRemoteSearchResults"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **trailerInfoRemoteSearchQuery** | [**TrailerInfoRemoteSearchQuery**](TrailerInfoRemoteSearchQuery.md)| Remote search query. | | + +### Return type + +[**List<RemoteSearchResult>**](RemoteSearchResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Trailer remote search executed. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemRefreshApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemRefreshApi.md new file mode 100644 index 0000000000000..a4297cb41fe52 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemRefreshApi.md @@ -0,0 +1,88 @@ +# ItemRefreshApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**refreshItem**](ItemRefreshApi.md#refreshItem) | **POST** /Items/{itemId}/Refresh | Refreshes metadata for an item. | + + + +# **refreshItem** +> refreshItem(itemId, metadataRefreshMode, imageRefreshMode, replaceAllMetadata, replaceAllImages, regenerateTrickplay) + +Refreshes metadata for an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemRefreshApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemRefreshApi apiInstance = new ItemRefreshApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + MetadataRefreshMode metadataRefreshMode = MetadataRefreshMode.fromValue("None"); // MetadataRefreshMode | (Optional) Specifies the metadata refresh mode. + MetadataRefreshMode imageRefreshMode = MetadataRefreshMode.fromValue("None"); // MetadataRefreshMode | (Optional) Specifies the image refresh mode. + Boolean replaceAllMetadata = false; // Boolean | (Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh. + Boolean replaceAllImages = false; // Boolean | (Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh. + Boolean regenerateTrickplay = false; // Boolean | (Optional) Determines if trickplay images should be replaced. Only applicable if mode is FullRefresh. + try { + apiInstance.refreshItem(itemId, metadataRefreshMode, imageRefreshMode, replaceAllMetadata, replaceAllImages, regenerateTrickplay); + } catch (ApiException e) { + System.err.println("Exception when calling ItemRefreshApi#refreshItem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **metadataRefreshMode** | **MetadataRefreshMode**| (Optional) Specifies the metadata refresh mode. | [optional] [default to None] [enum: None, ValidationOnly, Default, FullRefresh] | +| **imageRefreshMode** | **MetadataRefreshMode**| (Optional) Specifies the image refresh mode. | [optional] [default to None] [enum: None, ValidationOnly, Default, FullRefresh] | +| **replaceAllMetadata** | **Boolean**| (Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh. | [optional] [default to false] | +| **replaceAllImages** | **Boolean**| (Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh. | [optional] [default to false] | +| **regenerateTrickplay** | **Boolean**| (Optional) Determines if trickplay images should be replaced. Only applicable if mode is FullRefresh. | [optional] [default to false] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Item metadata refresh queued. | - | +| **404** | Item to refresh not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemSortBy.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemSortBy.md new file mode 100644 index 0000000000000..cd09a56e2cee8 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemSortBy.md @@ -0,0 +1,73 @@ + + +# ItemSortBy + +## Enum + + +* `DEFAULT` (value: `"Default"`) + +* `AIRED_EPISODE_ORDER` (value: `"AiredEpisodeOrder"`) + +* `ALBUM` (value: `"Album"`) + +* `ALBUM_ARTIST` (value: `"AlbumArtist"`) + +* `ARTIST` (value: `"Artist"`) + +* `DATE_CREATED` (value: `"DateCreated"`) + +* `OFFICIAL_RATING` (value: `"OfficialRating"`) + +* `DATE_PLAYED` (value: `"DatePlayed"`) + +* `PREMIERE_DATE` (value: `"PremiereDate"`) + +* `START_DATE` (value: `"StartDate"`) + +* `SORT_NAME` (value: `"SortName"`) + +* `NAME` (value: `"Name"`) + +* `RANDOM` (value: `"Random"`) + +* `RUNTIME` (value: `"Runtime"`) + +* `COMMUNITY_RATING` (value: `"CommunityRating"`) + +* `PRODUCTION_YEAR` (value: `"ProductionYear"`) + +* `PLAY_COUNT` (value: `"PlayCount"`) + +* `CRITIC_RATING` (value: `"CriticRating"`) + +* `IS_FOLDER` (value: `"IsFolder"`) + +* `IS_UNPLAYED` (value: `"IsUnplayed"`) + +* `IS_PLAYED` (value: `"IsPlayed"`) + +* `SERIES_SORT_NAME` (value: `"SeriesSortName"`) + +* `VIDEO_BIT_RATE` (value: `"VideoBitRate"`) + +* `AIR_TIME` (value: `"AirTime"`) + +* `STUDIO` (value: `"Studio"`) + +* `IS_FAVORITE_OR_LIKED` (value: `"IsFavoriteOrLiked"`) + +* `DATE_LAST_CONTENT_ADDED` (value: `"DateLastContentAdded"`) + +* `SERIES_DATE_PLAYED` (value: `"SeriesDatePlayed"`) + +* `PARENT_INDEX_NUMBER` (value: `"ParentIndexNumber"`) + +* `INDEX_NUMBER` (value: `"IndexNumber"`) + +* `SIMILARITY_SCORE` (value: `"SimilarityScore"`) + +* `SEARCH_SCORE` (value: `"SearchScore"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemUpdateApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemUpdateApi.md new file mode 100644 index 0000000000000..95ec04c230706 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemUpdateApi.md @@ -0,0 +1,223 @@ +# ItemUpdateApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getMetadataEditorInfo**](ItemUpdateApi.md#getMetadataEditorInfo) | **GET** /Items/{itemId}/MetadataEditor | Gets metadata editor info for an item. | +| [**updateItem**](ItemUpdateApi.md#updateItem) | **POST** /Items/{itemId} | Updates an item. | +| [**updateItemContentType**](ItemUpdateApi.md#updateItemContentType) | **POST** /Items/{itemId}/ContentType | Updates an item's content type. | + + + +# **getMetadataEditorInfo** +> MetadataEditorInfo getMetadataEditorInfo(itemId) + +Gets metadata editor info for an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemUpdateApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemUpdateApi apiInstance = new ItemUpdateApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + try { + MetadataEditorInfo result = apiInstance.getMetadataEditorInfo(itemId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ItemUpdateApi#getMetadataEditorInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | + +### Return type + +[**MetadataEditorInfo**](MetadataEditorInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Item metadata editor returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateItem** +> updateItem(itemId, baseItemDto) + +Updates an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemUpdateApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemUpdateApi apiInstance = new ItemUpdateApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + BaseItemDto baseItemDto = new BaseItemDto(); // BaseItemDto | The new item properties. + try { + apiInstance.updateItem(itemId, baseItemDto); + } catch (ApiException e) { + System.err.println("Exception when calling ItemUpdateApi#updateItem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **baseItemDto** | [**BaseItemDto**](BaseItemDto.md)| The new item properties. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Item updated. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateItemContentType** +> updateItemContentType(itemId, contentType) + +Updates an item's content type. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemUpdateApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemUpdateApi apiInstance = new ItemUpdateApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String contentType = "contentType_example"; // String | The content type of the item. + try { + apiInstance.updateItemContentType(itemId, contentType); + } catch (ApiException e) { + System.err.println("Exception when calling ItemUpdateApi#updateItemContentType"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **contentType** | **String**| The content type of the item. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Item content type updated. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemsApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemsApi.md new file mode 100644 index 0000000000000..4c5a2a66f4175 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ItemsApi.md @@ -0,0 +1,494 @@ +# ItemsApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getItemUserData**](ItemsApi.md#getItemUserData) | **GET** /UserItems/{itemId}/UserData | Get Item User Data. | +| [**getItems**](ItemsApi.md#getItems) | **GET** /Items | Gets items based on a query. | +| [**getResumeItems**](ItemsApi.md#getResumeItems) | **GET** /UserItems/Resume | Gets items based on a query. | +| [**updateItemUserData**](ItemsApi.md#updateItemUserData) | **POST** /UserItems/{itemId}/UserData | Update Item User Data. | + + + +# **getItemUserData** +> UserItemDataDto getItemUserData(itemId, userId) + +Get Item User Data. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemsApi apiInstance = new ItemsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + UUID userId = UUID.randomUUID(); // UUID | The user id. + try { + UserItemDataDto result = apiInstance.getItemUserData(itemId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ItemsApi#getItemUserData"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **userId** | **UUID**| The user id. | [optional] | + +### Return type + +[**UserItemDataDto**](UserItemDataDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | return item user data. | - | +| **404** | Item is not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getItems** +> BaseItemDtoQueryResult getItems(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, indexNumber, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages) + +Gets items based on a query. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemsApi apiInstance = new ItemsApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | The user id supplied as query parameter; this is required when not using an API key. + String maxOfficialRating = "maxOfficialRating_example"; // String | Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). + Boolean hasThemeSong = true; // Boolean | Optional filter by items with theme songs. + Boolean hasThemeVideo = true; // Boolean | Optional filter by items with theme videos. + Boolean hasSubtitles = true; // Boolean | Optional filter by items with subtitles. + Boolean hasSpecialFeature = true; // Boolean | Optional filter by items with special features. + Boolean hasTrailer = true; // Boolean | Optional filter by items with trailers. + UUID adjacentTo = UUID.randomUUID(); // UUID | Optional. Return items that are siblings of a supplied item. + Integer indexNumber = 56; // Integer | Optional filter by index number. + Integer parentIndexNumber = 56; // Integer | Optional filter by parent index number. + Boolean hasParentalRating = true; // Boolean | Optional filter by items that have or do not have a parental rating. + Boolean isHd = true; // Boolean | Optional filter by items that are HD or not. + Boolean is4K = true; // Boolean | Optional filter by items that are 4K or not. + List locationTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited. + List excludeLocationTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited. + Boolean isMissing = true; // Boolean | Optional filter by items that are missing episodes or not. + Boolean isUnaired = true; // Boolean | Optional filter by items that are unaired episodes or not. + Double minCommunityRating = 3.4D; // Double | Optional filter by minimum community rating. + Double minCriticRating = 3.4D; // Double | Optional filter by minimum critic rating. + OffsetDateTime minPremiereDate = OffsetDateTime.now(); // OffsetDateTime | Optional. The minimum premiere date. Format = ISO. + OffsetDateTime minDateLastSaved = OffsetDateTime.now(); // OffsetDateTime | Optional. The minimum last saved date. Format = ISO. + OffsetDateTime minDateLastSavedForUser = OffsetDateTime.now(); // OffsetDateTime | Optional. The minimum last saved date for the current user. Format = ISO. + OffsetDateTime maxPremiereDate = OffsetDateTime.now(); // OffsetDateTime | Optional. The maximum premiere date. Format = ISO. + Boolean hasOverview = true; // Boolean | Optional filter by items that have an overview or not. + Boolean hasImdbId = true; // Boolean | Optional filter by items that have an IMDb id or not. + Boolean hasTmdbId = true; // Boolean | Optional filter by items that have a TMDb id or not. + Boolean hasTvdbId = true; // Boolean | Optional filter by items that have a TVDb id or not. + Boolean isMovie = true; // Boolean | Optional filter for live tv movies. + Boolean isSeries = true; // Boolean | Optional filter for live tv series. + Boolean isNews = true; // Boolean | Optional filter for live tv news. + Boolean isKids = true; // Boolean | Optional filter for live tv kids. + Boolean isSports = true; // Boolean | Optional filter for live tv sports. + List excludeItemIds = Arrays.asList(); // List | Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + Boolean recursive = true; // Boolean | When searching within folders, this determines whether or not the search will be recursive. true/false. + String searchTerm = "searchTerm_example"; // String | Optional. Filter based on a search term. + List sortOrder = Arrays.asList(); // List | Sort Order - Ascending, Descending. + UUID parentId = UUID.randomUUID(); // UUID | Specify this to localize the search to a specific item or folder. Omit to use the root. + List fields = Arrays.asList(); // List | 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. + List excludeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. + List includeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. + List filters = Arrays.asList(); // List | Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. + Boolean isFavorite = true; // Boolean | Optional filter by items that are marked as favorite, or not. + List mediaTypes = Arrays.asList(); // List | Optional filter by MediaType. Allows multiple, comma delimited. + List imageTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. + List sortBy = Arrays.asList(); // List | Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. + Boolean isPlayed = true; // Boolean | Optional filter by items that are played, or not. + List genres = Arrays.asList(); // List | Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. + List officialRatings = Arrays.asList(); // List | Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. + List tags = Arrays.asList(); // List | Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. + List years = Arrays.asList(); // List | Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. + Boolean enableUserData = true; // Boolean | Optional, include user data. + Integer imageTypeLimit = 56; // Integer | Optional, the max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + String person = "person_example"; // String | Optional. If specified, results will be filtered to include only those containing the specified person. + List personIds = Arrays.asList(); // List | Optional. If specified, results will be filtered to include only those containing the specified person id. + List personTypes = Arrays.asList(); // List | Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. + List studios = Arrays.asList(); // List | Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. + List artists = Arrays.asList(); // List | Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited. + List excludeArtistIds = Arrays.asList(); // List | Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited. + List artistIds = Arrays.asList(); // List | Optional. If specified, results will be filtered to include only those containing the specified artist id. + List albumArtistIds = Arrays.asList(); // List | Optional. If specified, results will be filtered to include only those containing the specified album artist id. + List contributingArtistIds = Arrays.asList(); // List | Optional. If specified, results will be filtered to include only those containing the specified contributing artist id. + List albums = Arrays.asList(); // List | Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited. + List albumIds = Arrays.asList(); // List | Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited. + List ids = Arrays.asList(); // List | Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited. + List videoTypes = Arrays.asList(); // List | Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited. + String minOfficialRating = "minOfficialRating_example"; // String | Optional filter by minimum official rating (PG, PG-13, TV-MA, etc). + Boolean isLocked = true; // Boolean | Optional filter by items that are locked. + Boolean isPlaceHolder = true; // Boolean | Optional filter by items that are placeholders. + Boolean hasOfficialRating = true; // Boolean | Optional filter by items that have official ratings. + Boolean collapseBoxSetItems = true; // Boolean | Whether or not to hide items behind their boxsets. + Integer minWidth = 56; // Integer | Optional. Filter by the minimum width of the item. + Integer minHeight = 56; // Integer | Optional. Filter by the minimum height of the item. + Integer maxWidth = 56; // Integer | Optional. Filter by the maximum width of the item. + Integer maxHeight = 56; // Integer | Optional. Filter by the maximum height of the item. + Boolean is3D = true; // Boolean | Optional filter by items that are 3D, or not. + List seriesStatus = Arrays.asList(); // List | Optional filter by Series Status. Allows multiple, comma delimited. + String nameStartsWithOrGreater = "nameStartsWithOrGreater_example"; // String | Optional filter by items whose name is sorted equally or greater than a given input string. + String nameStartsWith = "nameStartsWith_example"; // String | Optional filter by items whose name is sorted equally than a given input string. + String nameLessThan = "nameLessThan_example"; // String | Optional filter by items whose name is equally or lesser than a given input string. + List studioIds = Arrays.asList(); // List | Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. + List genreIds = Arrays.asList(); // List | Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. + Boolean enableTotalRecordCount = true; // Boolean | Optional. Enable the total record count. + Boolean enableImages = true; // Boolean | Optional, include image information in output. + try { + BaseItemDtoQueryResult result = apiInstance.getItems(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, indexNumber, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ItemsApi#getItems"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| The user id supplied as query parameter; this is required when not using an API key. | [optional] | +| **maxOfficialRating** | **String**| Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). | [optional] | +| **hasThemeSong** | **Boolean**| Optional filter by items with theme songs. | [optional] | +| **hasThemeVideo** | **Boolean**| Optional filter by items with theme videos. | [optional] | +| **hasSubtitles** | **Boolean**| Optional filter by items with subtitles. | [optional] | +| **hasSpecialFeature** | **Boolean**| Optional filter by items with special features. | [optional] | +| **hasTrailer** | **Boolean**| Optional filter by items with trailers. | [optional] | +| **adjacentTo** | **UUID**| Optional. Return items that are siblings of a supplied item. | [optional] | +| **indexNumber** | **Integer**| Optional filter by index number. | [optional] | +| **parentIndexNumber** | **Integer**| Optional filter by parent index number. | [optional] | +| **hasParentalRating** | **Boolean**| Optional filter by items that have or do not have a parental rating. | [optional] | +| **isHd** | **Boolean**| Optional filter by items that are HD or not. | [optional] | +| **is4K** | **Boolean**| Optional filter by items that are 4K or not. | [optional] | +| **locationTypes** | [**List<LocationType>**](LocationType.md)| Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited. | [optional] | +| **excludeLocationTypes** | [**List<LocationType>**](LocationType.md)| Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited. | [optional] | +| **isMissing** | **Boolean**| Optional filter by items that are missing episodes or not. | [optional] | +| **isUnaired** | **Boolean**| Optional filter by items that are unaired episodes or not. | [optional] | +| **minCommunityRating** | **Double**| Optional filter by minimum community rating. | [optional] | +| **minCriticRating** | **Double**| Optional filter by minimum critic rating. | [optional] | +| **minPremiereDate** | **OffsetDateTime**| Optional. The minimum premiere date. Format = ISO. | [optional] | +| **minDateLastSaved** | **OffsetDateTime**| Optional. The minimum last saved date. Format = ISO. | [optional] | +| **minDateLastSavedForUser** | **OffsetDateTime**| Optional. The minimum last saved date for the current user. Format = ISO. | [optional] | +| **maxPremiereDate** | **OffsetDateTime**| Optional. The maximum premiere date. Format = ISO. | [optional] | +| **hasOverview** | **Boolean**| Optional filter by items that have an overview or not. | [optional] | +| **hasImdbId** | **Boolean**| Optional filter by items that have an IMDb id or not. | [optional] | +| **hasTmdbId** | **Boolean**| Optional filter by items that have a TMDb id or not. | [optional] | +| **hasTvdbId** | **Boolean**| Optional filter by items that have a TVDb id or not. | [optional] | +| **isMovie** | **Boolean**| Optional filter for live tv movies. | [optional] | +| **isSeries** | **Boolean**| Optional filter for live tv series. | [optional] | +| **isNews** | **Boolean**| Optional filter for live tv news. | [optional] | +| **isKids** | **Boolean**| Optional filter for live tv kids. | [optional] | +| **isSports** | **Boolean**| Optional filter for live tv sports. | [optional] | +| **excludeItemIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited. | [optional] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **recursive** | **Boolean**| When searching within folders, this determines whether or not the search will be recursive. true/false. | [optional] | +| **searchTerm** | **String**| Optional. Filter based on a search term. | [optional] | +| **sortOrder** | [**List<SortOrder>**](SortOrder.md)| Sort Order - Ascending, Descending. | [optional] | +| **parentId** | **UUID**| Specify this to localize the search to a specific item or folder. Omit to use the root. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| 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. | [optional] | +| **excludeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. | [optional] | +| **includeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. | [optional] | +| **filters** | [**List<ItemFilter>**](ItemFilter.md)| Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. | [optional] | +| **isFavorite** | **Boolean**| Optional filter by items that are marked as favorite, or not. | [optional] | +| **mediaTypes** | [**List<MediaType>**](MediaType.md)| Optional filter by MediaType. Allows multiple, comma delimited. | [optional] | +| **imageTypes** | [**List<ImageType>**](ImageType.md)| Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. | [optional] | +| **sortBy** | [**List<ItemSortBy>**](ItemSortBy.md)| Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. | [optional] | +| **isPlayed** | **Boolean**| Optional filter by items that are played, or not. | [optional] | +| **genres** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. | [optional] | +| **officialRatings** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. | [optional] | +| **tags** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. | [optional] | +| **years** | [**List<Integer>**](Integer.md)| Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. | [optional] | +| **enableUserData** | **Boolean**| Optional, include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional, the max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **person** | **String**| Optional. If specified, results will be filtered to include only those containing the specified person. | [optional] | +| **personIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered to include only those containing the specified person id. | [optional] | +| **personTypes** | [**List<String>**](String.md)| Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. | [optional] | +| **studios** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. | [optional] | +| **artists** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited. | [optional] | +| **excludeArtistIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited. | [optional] | +| **artistIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered to include only those containing the specified artist id. | [optional] | +| **albumArtistIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered to include only those containing the specified album artist id. | [optional] | +| **contributingArtistIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered to include only those containing the specified contributing artist id. | [optional] | +| **albums** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited. | [optional] | +| **albumIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited. | [optional] | +| **ids** | [**List<UUID>**](UUID.md)| Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited. | [optional] | +| **videoTypes** | [**List<VideoType>**](VideoType.md)| Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited. | [optional] | +| **minOfficialRating** | **String**| Optional filter by minimum official rating (PG, PG-13, TV-MA, etc). | [optional] | +| **isLocked** | **Boolean**| Optional filter by items that are locked. | [optional] | +| **isPlaceHolder** | **Boolean**| Optional filter by items that are placeholders. | [optional] | +| **hasOfficialRating** | **Boolean**| Optional filter by items that have official ratings. | [optional] | +| **collapseBoxSetItems** | **Boolean**| Whether or not to hide items behind their boxsets. | [optional] | +| **minWidth** | **Integer**| Optional. Filter by the minimum width of the item. | [optional] | +| **minHeight** | **Integer**| Optional. Filter by the minimum height of the item. | [optional] | +| **maxWidth** | **Integer**| Optional. Filter by the maximum width of the item. | [optional] | +| **maxHeight** | **Integer**| Optional. Filter by the maximum height of the item. | [optional] | +| **is3D** | **Boolean**| Optional filter by items that are 3D, or not. | [optional] | +| **seriesStatus** | [**List<SeriesStatus>**](SeriesStatus.md)| Optional filter by Series Status. Allows multiple, comma delimited. | [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] | +| **studioIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. | [optional] | +| **genreIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. | [optional] | +| **enableTotalRecordCount** | **Boolean**| Optional. Enable the total record count. | [optional] [default to true] | +| **enableImages** | **Boolean**| Optional, include image information in output. | [optional] [default to true] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getResumeItems** +> BaseItemDtoQueryResult getResumeItems(userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions) + +Gets items based on a query. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemsApi apiInstance = new ItemsApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | The user id. + Integer startIndex = 56; // Integer | The start index. + Integer limit = 56; // Integer | The item limit. + String searchTerm = "searchTerm_example"; // String | The search term. + UUID parentId = UUID.randomUUID(); // UUID | Specify this to localize the search to a specific item or folder. Omit to use the root. + List fields = Arrays.asList(); // List | 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. + List mediaTypes = Arrays.asList(); // List | Optional. Filter by MediaType. Allows multiple, comma delimited. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + List excludeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. + List includeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. + Boolean enableTotalRecordCount = true; // Boolean | Optional. Enable the total record count. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Boolean excludeActiveSessions = false; // Boolean | Optional. Whether to exclude the currently active sessions. + try { + BaseItemDtoQueryResult result = apiInstance.getResumeItems(userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ItemsApi#getResumeItems"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| The user id. | [optional] | +| **startIndex** | **Integer**| The start index. | [optional] | +| **limit** | **Integer**| The item limit. | [optional] | +| **searchTerm** | **String**| The search term. | [optional] | +| **parentId** | **UUID**| Specify this to localize the search to a specific item or folder. Omit to use the root. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| 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. | [optional] | +| **mediaTypes** | [**List<MediaType>**](MediaType.md)| Optional. Filter by MediaType. Allows multiple, comma delimited. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **excludeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. | [optional] | +| **includeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. | [optional] | +| **enableTotalRecordCount** | **Boolean**| Optional. Enable the total record count. | [optional] [default to true] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] [default to true] | +| **excludeActiveSessions** | **Boolean**| Optional. Whether to exclude the currently active sessions. | [optional] [default to false] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Items returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateItemUserData** +> UserItemDataDto updateItemUserData(itemId, updateUserItemDataDto, userId) + +Update Item User Data. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ItemsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ItemsApi apiInstance = new ItemsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + UpdateUserItemDataDto updateUserItemDataDto = new UpdateUserItemDataDto(); // UpdateUserItemDataDto | New user data object. + UUID userId = UUID.randomUUID(); // UUID | The user id. + try { + UserItemDataDto result = apiInstance.updateItemUserData(itemId, updateUserItemDataDto, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ItemsApi#updateItemUserData"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **updateUserItemDataDto** | [**UpdateUserItemDataDto**](UpdateUserItemDataDto.md)| New user data object. | | +| **userId** | **UUID**| The user id. | [optional] | + +### Return type + +[**UserItemDataDto**](UserItemDataDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | return updated user item data. | - | +| **404** | Item is not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/JoinGroupRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/JoinGroupRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/JoinGroupRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/JoinGroupRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/KeepUntil.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/KeepUntil.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/KeepUntil.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/KeepUntil.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryApi.md new file mode 100644 index 0000000000000..2000cd2d7d0a5 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryApi.md @@ -0,0 +1,1832 @@ +# LibraryApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**deleteItem**](LibraryApi.md#deleteItem) | **DELETE** /Items/{itemId} | Deletes an item from the library and filesystem. | +| [**deleteItems**](LibraryApi.md#deleteItems) | **DELETE** /Items | Deletes items from the library and filesystem. | +| [**getAncestors**](LibraryApi.md#getAncestors) | **GET** /Items/{itemId}/Ancestors | Gets all parents of an item. | +| [**getCriticReviews**](LibraryApi.md#getCriticReviews) | **GET** /Items/{itemId}/CriticReviews | Gets critic review for an item. | +| [**getDownload**](LibraryApi.md#getDownload) | **GET** /Items/{itemId}/Download | Downloads item media. | +| [**getFile**](LibraryApi.md#getFile) | **GET** /Items/{itemId}/File | Get the original file of an item. | +| [**getItemCounts**](LibraryApi.md#getItemCounts) | **GET** /Items/Counts | Get item counts. | +| [**getLibraryOptionsInfo**](LibraryApi.md#getLibraryOptionsInfo) | **GET** /Libraries/AvailableOptions | Gets the library options info. | +| [**getMediaFolders**](LibraryApi.md#getMediaFolders) | **GET** /Library/MediaFolders | Gets all user media folders. | +| [**getPhysicalPaths**](LibraryApi.md#getPhysicalPaths) | **GET** /Library/PhysicalPaths | Gets a list of physical paths from virtual folders. | +| [**getSimilarAlbums**](LibraryApi.md#getSimilarAlbums) | **GET** /Albums/{itemId}/Similar | Gets similar items. | +| [**getSimilarArtists**](LibraryApi.md#getSimilarArtists) | **GET** /Artists/{itemId}/Similar | Gets similar items. | +| [**getSimilarItems**](LibraryApi.md#getSimilarItems) | **GET** /Items/{itemId}/Similar | Gets similar items. | +| [**getSimilarMovies**](LibraryApi.md#getSimilarMovies) | **GET** /Movies/{itemId}/Similar | Gets similar items. | +| [**getSimilarShows**](LibraryApi.md#getSimilarShows) | **GET** /Shows/{itemId}/Similar | Gets similar items. | +| [**getSimilarTrailers**](LibraryApi.md#getSimilarTrailers) | **GET** /Trailers/{itemId}/Similar | Gets similar items. | +| [**getThemeMedia**](LibraryApi.md#getThemeMedia) | **GET** /Items/{itemId}/ThemeMedia | Get theme songs and videos for an item. | +| [**getThemeSongs**](LibraryApi.md#getThemeSongs) | **GET** /Items/{itemId}/ThemeSongs | Get theme songs for an item. | +| [**getThemeVideos**](LibraryApi.md#getThemeVideos) | **GET** /Items/{itemId}/ThemeVideos | Get theme videos for an item. | +| [**postAddedMovies**](LibraryApi.md#postAddedMovies) | **POST** /Library/Movies/Added | Reports that new movies have been added by an external source. | +| [**postAddedSeries**](LibraryApi.md#postAddedSeries) | **POST** /Library/Series/Added | Reports that new episodes of a series have been added by an external source. | +| [**postUpdatedMedia**](LibraryApi.md#postUpdatedMedia) | **POST** /Library/Media/Updated | Reports that new movies have been added by an external source. | +| [**postUpdatedMovies**](LibraryApi.md#postUpdatedMovies) | **POST** /Library/Movies/Updated | Reports that new movies have been added by an external source. | +| [**postUpdatedSeries**](LibraryApi.md#postUpdatedSeries) | **POST** /Library/Series/Updated | Reports that new episodes of a series have been added by an external source. | +| [**refreshLibrary**](LibraryApi.md#refreshLibrary) | **POST** /Library/Refresh | Starts a library scan. | + + + +# **deleteItem** +> deleteItem(itemId) + +Deletes an item from the library and filesystem. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + try { + apiInstance.deleteItem(itemId); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#deleteItem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Item deleted. | - | +| **401** | Unauthorized access. | - | +| **404** | Item not found. | - | +| **403** | Forbidden | - | + + +# **deleteItems** +> deleteItems(ids) + +Deletes items from the library and filesystem. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + List ids = Arrays.asList(); // List | The item ids. + try { + apiInstance.deleteItems(ids); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#deleteItems"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **ids** | [**List<UUID>**](UUID.md)| The item ids. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Items deleted. | - | +| **401** | Unauthorized access. | - | +| **404** | Not Found | - | +| **403** | Forbidden | - | + + +# **getAncestors** +> List<BaseItemDto> getAncestors(itemId, userId) + +Gets all parents of an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + try { + List result = apiInstance.getAncestors(itemId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getAncestors"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | + +### Return type + +[**List<BaseItemDto>**](BaseItemDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Item parents returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getCriticReviews** +> BaseItemDtoQueryResult getCriticReviews(itemId) + +Gets critic review for an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + String itemId = "itemId_example"; // String | + try { + BaseItemDtoQueryResult result = apiInstance.getCriticReviews(itemId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getCriticReviews"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **String**| | | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Critic reviews returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getDownload** +> File getDownload(itemId) + +Downloads item media. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + try { + File result = apiInstance.getDownload(itemId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getDownload"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: video/*, audio/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Media downloaded. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getFile** +> File getFile(itemId) + +Get the original file of an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + try { + File result = apiInstance.getFile(itemId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getFile"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: video/*, audio/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | File stream returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getItemCounts** +> ItemCounts getItemCounts(userId, isFavorite) + +Get item counts. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | Optional. Get counts from a specific user's library. + Boolean isFavorite = true; // Boolean | Optional. Get counts of favorite items. + try { + ItemCounts result = apiInstance.getItemCounts(userId, isFavorite); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getItemCounts"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| Optional. Get counts from a specific user's library. | [optional] | +| **isFavorite** | **Boolean**| Optional. Get counts of favorite items. | [optional] | + +### Return type + +[**ItemCounts**](ItemCounts.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Item counts returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getLibraryOptionsInfo** +> LibraryOptionsResultDto getLibraryOptionsInfo(libraryContentType, isNewLibrary) + +Gets the library options info. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + CollectionType libraryContentType = CollectionType.fromValue("unknown"); // CollectionType | Library content type. + Boolean isNewLibrary = false; // Boolean | Whether this is a new library. + try { + LibraryOptionsResultDto result = apiInstance.getLibraryOptionsInfo(libraryContentType, isNewLibrary); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getLibraryOptionsInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **libraryContentType** | **CollectionType**| Library content type. | [optional] [enum: unknown, movies, tvshows, music, musicvideos, trailers, homevideos, boxsets, books, photos, livetv, playlists, folders] | +| **isNewLibrary** | **Boolean**| Whether this is a new library. | [optional] [default to false] | + +### Return type + +[**LibraryOptionsResultDto**](LibraryOptionsResultDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Library options info returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getMediaFolders** +> BaseItemDtoQueryResult getMediaFolders(isHidden) + +Gets all user media folders. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + Boolean isHidden = true; // Boolean | Optional. Filter by folders that are marked hidden, or not. + try { + BaseItemDtoQueryResult result = apiInstance.getMediaFolders(isHidden); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getMediaFolders"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **isHidden** | **Boolean**| Optional. Filter by folders that are marked hidden, or not. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Media folders returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPhysicalPaths** +> List<String> getPhysicalPaths() + +Gets a list of physical paths from virtual folders. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + try { + List result = apiInstance.getPhysicalPaths(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getPhysicalPaths"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**List<String>** + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Physical paths returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getSimilarAlbums** +> BaseItemDtoQueryResult getSimilarAlbums(itemId, excludeArtistIds, userId, limit, fields) + +Gets similar items. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + List excludeArtistIds = Arrays.asList(); // List | Exclude artist ids. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | 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. + try { + BaseItemDtoQueryResult result = apiInstance.getSimilarAlbums(itemId, excludeArtistIds, userId, limit, fields); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getSimilarAlbums"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **excludeArtistIds** | [**List<UUID>**](UUID.md)| Exclude artist ids. | [optional] | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| 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**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Similar items returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getSimilarArtists** +> BaseItemDtoQueryResult getSimilarArtists(itemId, excludeArtistIds, userId, limit, fields) + +Gets similar items. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + List excludeArtistIds = Arrays.asList(); // List | Exclude artist ids. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | 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. + try { + BaseItemDtoQueryResult result = apiInstance.getSimilarArtists(itemId, excludeArtistIds, userId, limit, fields); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getSimilarArtists"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **excludeArtistIds** | [**List<UUID>**](UUID.md)| Exclude artist ids. | [optional] | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| 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**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Similar items returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getSimilarItems** +> BaseItemDtoQueryResult getSimilarItems(itemId, excludeArtistIds, userId, limit, fields) + +Gets similar items. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + List excludeArtistIds = Arrays.asList(); // List | Exclude artist ids. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | 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. + try { + BaseItemDtoQueryResult result = apiInstance.getSimilarItems(itemId, excludeArtistIds, userId, limit, fields); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getSimilarItems"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **excludeArtistIds** | [**List<UUID>**](UUID.md)| Exclude artist ids. | [optional] | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| 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**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Similar items returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getSimilarMovies** +> BaseItemDtoQueryResult getSimilarMovies(itemId, excludeArtistIds, userId, limit, fields) + +Gets similar items. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + List excludeArtistIds = Arrays.asList(); // List | Exclude artist ids. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | 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. + try { + BaseItemDtoQueryResult result = apiInstance.getSimilarMovies(itemId, excludeArtistIds, userId, limit, fields); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getSimilarMovies"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **excludeArtistIds** | [**List<UUID>**](UUID.md)| Exclude artist ids. | [optional] | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| 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**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Similar items returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getSimilarShows** +> BaseItemDtoQueryResult getSimilarShows(itemId, excludeArtistIds, userId, limit, fields) + +Gets similar items. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + List excludeArtistIds = Arrays.asList(); // List | Exclude artist ids. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | 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. + try { + BaseItemDtoQueryResult result = apiInstance.getSimilarShows(itemId, excludeArtistIds, userId, limit, fields); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getSimilarShows"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **excludeArtistIds** | [**List<UUID>**](UUID.md)| Exclude artist ids. | [optional] | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| 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**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Similar items returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getSimilarTrailers** +> BaseItemDtoQueryResult getSimilarTrailers(itemId, excludeArtistIds, userId, limit, fields) + +Gets similar items. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + List excludeArtistIds = Arrays.asList(); // List | Exclude artist ids. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | 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. + try { + BaseItemDtoQueryResult result = apiInstance.getSimilarTrailers(itemId, excludeArtistIds, userId, limit, fields); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getSimilarTrailers"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **excludeArtistIds** | [**List<UUID>**](UUID.md)| Exclude artist ids. | [optional] | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| 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**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Similar items returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getThemeMedia** +> AllThemeMediaResult getThemeMedia(itemId, userId, inheritFromParent, sortBy, sortOrder) + +Get theme songs and videos for an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Boolean inheritFromParent = false; // Boolean | Optional. Determines whether or not parent items should be searched for theme media. + List sortBy = Arrays.asList(); // List | Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. + List sortOrder = Arrays.asList(); // List | Optional. Sort Order - Ascending, Descending. + try { + AllThemeMediaResult result = apiInstance.getThemeMedia(itemId, userId, inheritFromParent, sortBy, sortOrder); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getThemeMedia"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **inheritFromParent** | **Boolean**| Optional. Determines whether or not parent items should be searched for theme media. | [optional] [default to false] | +| **sortBy** | [**List<ItemSortBy>**](ItemSortBy.md)| Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. | [optional] | +| **sortOrder** | [**List<SortOrder>**](SortOrder.md)| Optional. Sort Order - Ascending, Descending. | [optional] | + +### Return type + +[**AllThemeMediaResult**](AllThemeMediaResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Theme songs and videos returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getThemeSongs** +> ThemeMediaResult getThemeSongs(itemId, userId, inheritFromParent, sortBy, sortOrder) + +Get theme songs for an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Boolean inheritFromParent = false; // Boolean | Optional. Determines whether or not parent items should be searched for theme media. + List sortBy = Arrays.asList(); // List | Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. + List sortOrder = Arrays.asList(); // List | Optional. Sort Order - Ascending, Descending. + try { + ThemeMediaResult result = apiInstance.getThemeSongs(itemId, userId, inheritFromParent, sortBy, sortOrder); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getThemeSongs"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **inheritFromParent** | **Boolean**| Optional. Determines whether or not parent items should be searched for theme media. | [optional] [default to false] | +| **sortBy** | [**List<ItemSortBy>**](ItemSortBy.md)| Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. | [optional] | +| **sortOrder** | [**List<SortOrder>**](SortOrder.md)| Optional. Sort Order - Ascending, Descending. | [optional] | + +### Return type + +[**ThemeMediaResult**](ThemeMediaResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Theme songs returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getThemeVideos** +> ThemeMediaResult getThemeVideos(itemId, userId, inheritFromParent, sortBy, sortOrder) + +Get theme videos for an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + Boolean inheritFromParent = false; // Boolean | Optional. Determines whether or not parent items should be searched for theme media. + List sortBy = Arrays.asList(); // List | Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. + List sortOrder = Arrays.asList(); // List | Optional. Sort Order - Ascending, Descending. + try { + ThemeMediaResult result = apiInstance.getThemeVideos(itemId, userId, inheritFromParent, sortBy, sortOrder); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#getThemeVideos"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **inheritFromParent** | **Boolean**| Optional. Determines whether or not parent items should be searched for theme media. | [optional] [default to false] | +| **sortBy** | [**List<ItemSortBy>**](ItemSortBy.md)| Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. | [optional] | +| **sortOrder** | [**List<SortOrder>**](SortOrder.md)| Optional. Sort Order - Ascending, Descending. | [optional] | + +### Return type + +[**ThemeMediaResult**](ThemeMediaResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Theme videos returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **postAddedMovies** +> postAddedMovies(tmdbId, imdbId) + +Reports that new movies have been added by an external source. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + String tmdbId = "tmdbId_example"; // String | The tmdbId. + String imdbId = "imdbId_example"; // String | The imdbId. + try { + apiInstance.postAddedMovies(tmdbId, imdbId); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#postAddedMovies"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **tmdbId** | **String**| The tmdbId. | [optional] | +| **imdbId** | **String**| The imdbId. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Report success. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **postAddedSeries** +> postAddedSeries(tvdbId) + +Reports that new episodes of a series have been added by an external source. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + String tvdbId = "tvdbId_example"; // String | The tvdbId. + try { + apiInstance.postAddedSeries(tvdbId); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#postAddedSeries"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **tvdbId** | **String**| The tvdbId. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Report success. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **postUpdatedMedia** +> postUpdatedMedia(mediaUpdateInfoDto) + +Reports that new movies have been added by an external source. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + MediaUpdateInfoDto mediaUpdateInfoDto = new MediaUpdateInfoDto(); // MediaUpdateInfoDto | The update paths. + try { + apiInstance.postUpdatedMedia(mediaUpdateInfoDto); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#postUpdatedMedia"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **mediaUpdateInfoDto** | [**MediaUpdateInfoDto**](MediaUpdateInfoDto.md)| The update paths. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Report success. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **postUpdatedMovies** +> postUpdatedMovies(tmdbId, imdbId) + +Reports that new movies have been added by an external source. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + String tmdbId = "tmdbId_example"; // String | The tmdbId. + String imdbId = "imdbId_example"; // String | The imdbId. + try { + apiInstance.postUpdatedMovies(tmdbId, imdbId); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#postUpdatedMovies"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **tmdbId** | **String**| The tmdbId. | [optional] | +| **imdbId** | **String**| The imdbId. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Report success. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **postUpdatedSeries** +> postUpdatedSeries(tvdbId) + +Reports that new episodes of a series have been added by an external source. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + String tvdbId = "tvdbId_example"; // String | The tvdbId. + try { + apiInstance.postUpdatedSeries(tvdbId); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#postUpdatedSeries"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **tvdbId** | **String**| The tvdbId. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Report success. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **refreshLibrary** +> refreshLibrary() + +Starts a library scan. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryApi apiInstance = new LibraryApi(defaultClient); + try { + apiInstance.refreshLibrary(); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryApi#refreshLibrary"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Library scan started. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryChangedMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryChangedMessage.md new file mode 100644 index 0000000000000..41bc346821c21 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryChangedMessage.md @@ -0,0 +1,16 @@ + + +# LibraryChangedMessage + +Library changed message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**LibraryUpdateInfo**](LibraryUpdateInfo.md) | Class LibraryUpdateInfo. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LibraryOptionInfoDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryOptionInfoDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LibraryOptionInfoDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryOptionInfoDto.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryOptions.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryOptions.md new file mode 100644 index 0000000000000..d5a5b5a821a7f --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryOptions.md @@ -0,0 +1,54 @@ + + +# LibraryOptions + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**enabled** | **Boolean** | | [optional] | +|**enablePhotos** | **Boolean** | | [optional] | +|**enableRealtimeMonitor** | **Boolean** | | [optional] | +|**enableLUFSScan** | **Boolean** | | [optional] | +|**enableChapterImageExtraction** | **Boolean** | | [optional] | +|**extractChapterImagesDuringLibraryScan** | **Boolean** | | [optional] | +|**enableTrickplayImageExtraction** | **Boolean** | | [optional] | +|**extractTrickplayImagesDuringLibraryScan** | **Boolean** | | [optional] | +|**pathInfos** | [**List<MediaPathInfo>**](MediaPathInfo.md) | | [optional] | +|**saveLocalMetadata** | **Boolean** | | [optional] | +|**enableInternetProviders** | **Boolean** | | [optional] | +|**enableAutomaticSeriesGrouping** | **Boolean** | | [optional] | +|**enableEmbeddedTitles** | **Boolean** | | [optional] | +|**enableEmbeddedExtrasTitles** | **Boolean** | | [optional] | +|**enableEmbeddedEpisodeInfos** | **Boolean** | | [optional] | +|**automaticRefreshIntervalDays** | **Integer** | | [optional] | +|**preferredMetadataLanguage** | **String** | Gets or sets the preferred metadata language. | [optional] | +|**metadataCountryCode** | **String** | Gets or sets the metadata country code. | [optional] | +|**seasonZeroDisplayName** | **String** | | [optional] | +|**metadataSavers** | **List<String>** | | [optional] | +|**disabledLocalMetadataReaders** | **List<String>** | | [optional] | +|**localMetadataReaderOrder** | **List<String>** | | [optional] | +|**disabledSubtitleFetchers** | **List<String>** | | [optional] | +|**subtitleFetcherOrder** | **List<String>** | | [optional] | +|**disabledMediaSegmentProviders** | **List<String>** | | [optional] | +|**mediaSegmentProvideOrder** | **List<String>** | | [optional] | +|**skipSubtitlesIfEmbeddedSubtitlesPresent** | **Boolean** | | [optional] | +|**skipSubtitlesIfAudioTrackMatches** | **Boolean** | | [optional] | +|**subtitleDownloadLanguages** | **List<String>** | | [optional] | +|**requirePerfectSubtitleMatch** | **Boolean** | | [optional] | +|**saveSubtitlesWithMedia** | **Boolean** | | [optional] | +|**saveLyricsWithMedia** | **Boolean** | | [optional] | +|**saveTrickplayWithMedia** | **Boolean** | | [optional] | +|**disabledLyricFetchers** | **List<String>** | | [optional] | +|**lyricFetcherOrder** | **List<String>** | | [optional] | +|**preferNonstandardArtistsTag** | **Boolean** | | [optional] | +|**useCustomTagDelimiters** | **Boolean** | | [optional] | +|**customTagDelimiters** | **List<String>** | | [optional] | +|**delimiterWhitelist** | **List<String>** | | [optional] | +|**automaticallyAddToCollection** | **Boolean** | | [optional] | +|**allowEmbeddedSubtitles** | **EmbeddedSubtitleOptions** | An enum representing the options to disable embedded subs. | [optional] | +|**typeOptions** | [**List<TypeOptions>**](TypeOptions.md) | | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/LibraryOptionsResultDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryOptionsResultDto.md similarity index 83% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/LibraryOptionsResultDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryOptionsResultDto.md index 88ca07b312bef..e23f647476d46 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/LibraryOptionsResultDto.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryOptionsResultDto.md @@ -11,6 +11,7 @@ Library options result dto. |**metadataSavers** | [**List<LibraryOptionInfoDto>**](LibraryOptionInfoDto.md) | Gets or sets the metadata savers. | [optional] | |**metadataReaders** | [**List<LibraryOptionInfoDto>**](LibraryOptionInfoDto.md) | Gets or sets the metadata readers. | [optional] | |**subtitleFetchers** | [**List<LibraryOptionInfoDto>**](LibraryOptionInfoDto.md) | Gets or sets the subtitle fetchers. | [optional] | +|**lyricFetchers** | [**List<LibraryOptionInfoDto>**](LibraryOptionInfoDto.md) | Gets or sets the list of lyric fetchers. | [optional] | |**typeOptions** | [**List<LibraryTypeOptionsDto>**](LibraryTypeOptionsDto.md) | Gets or sets the type options. | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryStructureApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryStructureApi.md new file mode 100644 index 0000000000000..92444fdc320dc --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryStructureApi.md @@ -0,0 +1,580 @@ +# LibraryStructureApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**addMediaPath**](LibraryStructureApi.md#addMediaPath) | **POST** /Library/VirtualFolders/Paths | Add a media path to a library. | +| [**addVirtualFolder**](LibraryStructureApi.md#addVirtualFolder) | **POST** /Library/VirtualFolders | Adds a virtual folder. | +| [**getVirtualFolders**](LibraryStructureApi.md#getVirtualFolders) | **GET** /Library/VirtualFolders | Gets all virtual folders. | +| [**removeMediaPath**](LibraryStructureApi.md#removeMediaPath) | **DELETE** /Library/VirtualFolders/Paths | Remove a media path. | +| [**removeVirtualFolder**](LibraryStructureApi.md#removeVirtualFolder) | **DELETE** /Library/VirtualFolders | Removes a virtual folder. | +| [**renameVirtualFolder**](LibraryStructureApi.md#renameVirtualFolder) | **POST** /Library/VirtualFolders/Name | Renames a virtual folder. | +| [**updateLibraryOptions**](LibraryStructureApi.md#updateLibraryOptions) | **POST** /Library/VirtualFolders/LibraryOptions | Update library options. | +| [**updateMediaPath**](LibraryStructureApi.md#updateMediaPath) | **POST** /Library/VirtualFolders/Paths/Update | Updates a media path. | + + + +# **addMediaPath** +> addMediaPath(mediaPathDto, refreshLibrary) + +Add a media path to a library. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryStructureApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryStructureApi apiInstance = new LibraryStructureApi(defaultClient); + MediaPathDto mediaPathDto = new MediaPathDto(); // MediaPathDto | The media path dto. + Boolean refreshLibrary = false; // Boolean | Whether to refresh the library. + try { + apiInstance.addMediaPath(mediaPathDto, refreshLibrary); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryStructureApi#addMediaPath"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **mediaPathDto** | [**MediaPathDto**](MediaPathDto.md)| The media path dto. | | +| **refreshLibrary** | **Boolean**| Whether to refresh the library. | [optional] [default to false] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Media path added. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **addVirtualFolder** +> addVirtualFolder(name, collectionType, paths, refreshLibrary, addVirtualFolderDto) + +Adds a virtual folder. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryStructureApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryStructureApi apiInstance = new LibraryStructureApi(defaultClient); + String name = "name_example"; // String | The name of the virtual folder. + CollectionTypeOptions collectionType = CollectionTypeOptions.fromValue("movies"); // CollectionTypeOptions | The type of the collection. + List paths = Arrays.asList(); // List | The paths of the virtual folder. + Boolean refreshLibrary = false; // Boolean | Whether to refresh the library. + AddVirtualFolderDto addVirtualFolderDto = new AddVirtualFolderDto(); // AddVirtualFolderDto | The library options. + try { + apiInstance.addVirtualFolder(name, collectionType, paths, refreshLibrary, addVirtualFolderDto); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryStructureApi#addVirtualFolder"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| The name of the virtual folder. | [optional] | +| **collectionType** | **CollectionTypeOptions**| The type of the collection. | [optional] [enum: movies, tvshows, music, musicvideos, homevideos, boxsets, books, mixed] | +| **paths** | [**List<String>**](String.md)| The paths of the virtual folder. | [optional] | +| **refreshLibrary** | **Boolean**| Whether to refresh the library. | [optional] [default to false] | +| **addVirtualFolderDto** | [**AddVirtualFolderDto**](AddVirtualFolderDto.md)| The library options. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Folder added. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getVirtualFolders** +> List<VirtualFolderInfo> getVirtualFolders() + +Gets all virtual folders. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryStructureApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryStructureApi apiInstance = new LibraryStructureApi(defaultClient); + try { + List result = apiInstance.getVirtualFolders(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryStructureApi#getVirtualFolders"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<VirtualFolderInfo>**](VirtualFolderInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Virtual folders retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **removeMediaPath** +> removeMediaPath(name, path, refreshLibrary) + +Remove a media path. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryStructureApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryStructureApi apiInstance = new LibraryStructureApi(defaultClient); + String name = "name_example"; // String | The name of the library. + String path = "path_example"; // String | The path to remove. + Boolean refreshLibrary = false; // Boolean | Whether to refresh the library. + try { + apiInstance.removeMediaPath(name, path, refreshLibrary); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryStructureApi#removeMediaPath"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| The name of the library. | [optional] | +| **path** | **String**| The path to remove. | [optional] | +| **refreshLibrary** | **Boolean**| Whether to refresh the library. | [optional] [default to false] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Media path removed. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **removeVirtualFolder** +> removeVirtualFolder(name, refreshLibrary) + +Removes a virtual folder. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryStructureApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryStructureApi apiInstance = new LibraryStructureApi(defaultClient); + String name = "name_example"; // String | The name of the folder. + Boolean refreshLibrary = false; // Boolean | Whether to refresh the library. + try { + apiInstance.removeVirtualFolder(name, refreshLibrary); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryStructureApi#removeVirtualFolder"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| The name of the folder. | [optional] | +| **refreshLibrary** | **Boolean**| Whether to refresh the library. | [optional] [default to false] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Folder removed. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **renameVirtualFolder** +> renameVirtualFolder(name, newName, refreshLibrary) + +Renames a virtual folder. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryStructureApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryStructureApi apiInstance = new LibraryStructureApi(defaultClient); + String name = "name_example"; // String | The name of the virtual folder. + String newName = "newName_example"; // String | The new name. + Boolean refreshLibrary = false; // Boolean | Whether to refresh the library. + try { + apiInstance.renameVirtualFolder(name, newName, refreshLibrary); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryStructureApi#renameVirtualFolder"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| The name of the virtual folder. | [optional] | +| **newName** | **String**| The new name. | [optional] | +| **refreshLibrary** | **Boolean**| Whether to refresh the library. | [optional] [default to false] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Folder renamed. | - | +| **404** | Library doesn't exist. | - | +| **409** | Library already exists. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateLibraryOptions** +> updateLibraryOptions(updateLibraryOptionsDto) + +Update library options. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryStructureApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryStructureApi apiInstance = new LibraryStructureApi(defaultClient); + UpdateLibraryOptionsDto updateLibraryOptionsDto = new UpdateLibraryOptionsDto(); // UpdateLibraryOptionsDto | The library name and options. + try { + apiInstance.updateLibraryOptions(updateLibraryOptionsDto); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryStructureApi#updateLibraryOptions"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **updateLibraryOptionsDto** | [**UpdateLibraryOptionsDto**](UpdateLibraryOptionsDto.md)| The library name and options. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Library updated. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateMediaPath** +> updateMediaPath(updateMediaPathRequestDto) + +Updates a media path. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LibraryStructureApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LibraryStructureApi apiInstance = new LibraryStructureApi(defaultClient); + UpdateMediaPathRequestDto updateMediaPathRequestDto = new UpdateMediaPathRequestDto(); // UpdateMediaPathRequestDto | The name of the library and path infos. + try { + apiInstance.updateMediaPath(updateMediaPathRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling LibraryStructureApi#updateMediaPath"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **updateMediaPathRequestDto** | [**UpdateMediaPathRequestDto**](UpdateMediaPathRequestDto.md)| The name of the library and path infos. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Media path updated. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LibraryTypeOptionsDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryTypeOptionsDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LibraryTypeOptionsDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryTypeOptionsDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LibraryUpdateInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryUpdateInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LibraryUpdateInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LibraryUpdateInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ListingsProviderInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ListingsProviderInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ListingsProviderInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ListingsProviderInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LiveStreamResponse.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LiveStreamResponse.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LiveStreamResponse.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LiveStreamResponse.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LiveTvApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LiveTvApi.md new file mode 100644 index 0000000000000..6c674a1785ab0 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LiveTvApi.md @@ -0,0 +1,3051 @@ +# LiveTvApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**addListingProvider**](LiveTvApi.md#addListingProvider) | **POST** /LiveTv/ListingProviders | Adds a listings provider. | +| [**addTunerHost**](LiveTvApi.md#addTunerHost) | **POST** /LiveTv/TunerHosts | Adds a tuner host. | +| [**cancelSeriesTimer**](LiveTvApi.md#cancelSeriesTimer) | **DELETE** /LiveTv/SeriesTimers/{timerId} | Cancels a live tv series timer. | +| [**cancelTimer**](LiveTvApi.md#cancelTimer) | **DELETE** /LiveTv/Timers/{timerId} | Cancels a live tv timer. | +| [**createSeriesTimer**](LiveTvApi.md#createSeriesTimer) | **POST** /LiveTv/SeriesTimers | Creates a live tv series timer. | +| [**createTimer**](LiveTvApi.md#createTimer) | **POST** /LiveTv/Timers | Creates a live tv timer. | +| [**deleteListingProvider**](LiveTvApi.md#deleteListingProvider) | **DELETE** /LiveTv/ListingProviders | Delete listing provider. | +| [**deleteRecording**](LiveTvApi.md#deleteRecording) | **DELETE** /LiveTv/Recordings/{recordingId} | Deletes a live tv recording. | +| [**deleteTunerHost**](LiveTvApi.md#deleteTunerHost) | **DELETE** /LiveTv/TunerHosts | Deletes a tuner host. | +| [**discoverTuners**](LiveTvApi.md#discoverTuners) | **GET** /LiveTv/Tuners/Discover | Discover tuners. | +| [**discvoverTuners**](LiveTvApi.md#discvoverTuners) | **GET** /LiveTv/Tuners/Discvover | Discover tuners. | +| [**getChannel**](LiveTvApi.md#getChannel) | **GET** /LiveTv/Channels/{channelId} | Gets a live tv channel. | +| [**getChannelMappingOptions**](LiveTvApi.md#getChannelMappingOptions) | **GET** /LiveTv/ChannelMappingOptions | Get channel mapping options. | +| [**getDefaultListingProvider**](LiveTvApi.md#getDefaultListingProvider) | **GET** /LiveTv/ListingProviders/Default | Gets default listings provider info. | +| [**getDefaultTimer**](LiveTvApi.md#getDefaultTimer) | **GET** /LiveTv/Timers/Defaults | Gets the default values for a new timer. | +| [**getGuideInfo**](LiveTvApi.md#getGuideInfo) | **GET** /LiveTv/GuideInfo | Get guid info. | +| [**getLineups**](LiveTvApi.md#getLineups) | **GET** /LiveTv/ListingProviders/Lineups | Gets available lineups. | +| [**getLiveRecordingFile**](LiveTvApi.md#getLiveRecordingFile) | **GET** /LiveTv/LiveRecordings/{recordingId}/stream | Gets a live tv recording stream. | +| [**getLiveStreamFile**](LiveTvApi.md#getLiveStreamFile) | **GET** /LiveTv/LiveStreamFiles/{streamId}/stream.{container} | Gets a live tv channel stream. | +| [**getLiveTvChannels**](LiveTvApi.md#getLiveTvChannels) | **GET** /LiveTv/Channels | Gets available live tv channels. | +| [**getLiveTvInfo**](LiveTvApi.md#getLiveTvInfo) | **GET** /LiveTv/Info | Gets available live tv services. | +| [**getLiveTvPrograms**](LiveTvApi.md#getLiveTvPrograms) | **GET** /LiveTv/Programs | Gets available live tv epgs. | +| [**getProgram**](LiveTvApi.md#getProgram) | **GET** /LiveTv/Programs/{programId} | Gets a live tv program. | +| [**getPrograms**](LiveTvApi.md#getPrograms) | **POST** /LiveTv/Programs | Gets available live tv epgs. | +| [**getRecommendedPrograms**](LiveTvApi.md#getRecommendedPrograms) | **GET** /LiveTv/Programs/Recommended | Gets recommended live tv epgs. | +| [**getRecording**](LiveTvApi.md#getRecording) | **GET** /LiveTv/Recordings/{recordingId} | Gets a live tv recording. | +| [**getRecordingFolders**](LiveTvApi.md#getRecordingFolders) | **GET** /LiveTv/Recordings/Folders | Gets recording folders. | +| [**getRecordingGroup**](LiveTvApi.md#getRecordingGroup) | **GET** /LiveTv/Recordings/Groups/{groupId} | Get recording group. | +| [**getRecordingGroups**](LiveTvApi.md#getRecordingGroups) | **GET** /LiveTv/Recordings/Groups | Gets live tv recording groups. | +| [**getRecordings**](LiveTvApi.md#getRecordings) | **GET** /LiveTv/Recordings | Gets live tv recordings. | +| [**getRecordingsSeries**](LiveTvApi.md#getRecordingsSeries) | **GET** /LiveTv/Recordings/Series | Gets live tv recording series. | +| [**getSchedulesDirectCountries**](LiveTvApi.md#getSchedulesDirectCountries) | **GET** /LiveTv/ListingProviders/SchedulesDirect/Countries | Gets available countries. | +| [**getSeriesTimer**](LiveTvApi.md#getSeriesTimer) | **GET** /LiveTv/SeriesTimers/{timerId} | Gets a live tv series timer. | +| [**getSeriesTimers**](LiveTvApi.md#getSeriesTimers) | **GET** /LiveTv/SeriesTimers | Gets live tv series timers. | +| [**getTimer**](LiveTvApi.md#getTimer) | **GET** /LiveTv/Timers/{timerId} | Gets a timer. | +| [**getTimers**](LiveTvApi.md#getTimers) | **GET** /LiveTv/Timers | Gets the live tv timers. | +| [**getTunerHostTypes**](LiveTvApi.md#getTunerHostTypes) | **GET** /LiveTv/TunerHosts/Types | Get tuner host types. | +| [**resetTuner**](LiveTvApi.md#resetTuner) | **POST** /LiveTv/Tuners/{tunerId}/Reset | Resets a tv tuner. | +| [**setChannelMapping**](LiveTvApi.md#setChannelMapping) | **POST** /LiveTv/ChannelMappings | Set channel mappings. | +| [**updateSeriesTimer**](LiveTvApi.md#updateSeriesTimer) | **POST** /LiveTv/SeriesTimers/{timerId} | Updates a live tv series timer. | +| [**updateTimer**](LiveTvApi.md#updateTimer) | **POST** /LiveTv/Timers/{timerId} | Updates a live tv timer. | + + + +# **addListingProvider** +> ListingsProviderInfo addListingProvider(pw, validateListings, validateLogin, listingsProviderInfo) + +Adds a listings provider. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String pw = "pw_example"; // String | Password. + Boolean validateListings = false; // Boolean | Validate listings. + Boolean validateLogin = false; // Boolean | Validate login. + ListingsProviderInfo listingsProviderInfo = new ListingsProviderInfo(); // ListingsProviderInfo | New listings info. + try { + ListingsProviderInfo result = apiInstance.addListingProvider(pw, validateListings, validateLogin, listingsProviderInfo); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#addListingProvider"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **pw** | **String**| Password. | [optional] | +| **validateListings** | **Boolean**| Validate listings. | [optional] [default to false] | +| **validateLogin** | **Boolean**| Validate login. | [optional] [default to false] | +| **listingsProviderInfo** | [**ListingsProviderInfo**](ListingsProviderInfo.md)| New listings info. | [optional] | + +### Return type + +[**ListingsProviderInfo**](ListingsProviderInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Created listings provider returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **addTunerHost** +> TunerHostInfo addTunerHost(tunerHostInfo) + +Adds a tuner host. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + TunerHostInfo tunerHostInfo = new TunerHostInfo(); // TunerHostInfo | New tuner host. + try { + TunerHostInfo result = apiInstance.addTunerHost(tunerHostInfo); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#addTunerHost"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **tunerHostInfo** | [**TunerHostInfo**](TunerHostInfo.md)| New tuner host. | [optional] | + +### Return type + +[**TunerHostInfo**](TunerHostInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Created tuner host returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **cancelSeriesTimer** +> cancelSeriesTimer(timerId) + +Cancels a live tv series timer. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String timerId = "timerId_example"; // String | Timer id. + try { + apiInstance.cancelSeriesTimer(timerId); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#cancelSeriesTimer"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **timerId** | **String**| Timer id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Timer cancelled. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **cancelTimer** +> cancelTimer(timerId) + +Cancels a live tv timer. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String timerId = "timerId_example"; // String | Timer id. + try { + apiInstance.cancelTimer(timerId); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#cancelTimer"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **timerId** | **String**| Timer id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Timer deleted. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **createSeriesTimer** +> createSeriesTimer(seriesTimerInfoDto) + +Creates a live tv series timer. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + SeriesTimerInfoDto seriesTimerInfoDto = new SeriesTimerInfoDto(); // SeriesTimerInfoDto | New series timer info. + try { + apiInstance.createSeriesTimer(seriesTimerInfoDto); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#createSeriesTimer"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **seriesTimerInfoDto** | [**SeriesTimerInfoDto**](SeriesTimerInfoDto.md)| New series timer info. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Series timer info created. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **createTimer** +> createTimer(timerInfoDto) + +Creates a live tv timer. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + TimerInfoDto timerInfoDto = new TimerInfoDto(); // TimerInfoDto | New timer info. + try { + apiInstance.createTimer(timerInfoDto); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#createTimer"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **timerInfoDto** | [**TimerInfoDto**](TimerInfoDto.md)| New timer info. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Timer created. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **deleteListingProvider** +> deleteListingProvider(id) + +Delete listing provider. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String id = "id_example"; // String | Listing provider id. + try { + apiInstance.deleteListingProvider(id); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#deleteListingProvider"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **id** | **String**| Listing provider id. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Listing provider deleted. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **deleteRecording** +> deleteRecording(recordingId) + +Deletes a live tv recording. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + UUID recordingId = UUID.randomUUID(); // UUID | Recording id. + try { + apiInstance.deleteRecording(recordingId); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#deleteRecording"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **recordingId** | **UUID**| Recording id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Recording deleted. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **deleteTunerHost** +> deleteTunerHost(id) + +Deletes a tuner host. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String id = "id_example"; // String | Tuner host id. + try { + apiInstance.deleteTunerHost(id); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#deleteTunerHost"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **id** | **String**| Tuner host id. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Tuner host deleted. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **discoverTuners** +> List<TunerHostInfo> discoverTuners(newDevicesOnly) + +Discover tuners. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + Boolean newDevicesOnly = false; // Boolean | Only discover new tuners. + try { + List result = apiInstance.discoverTuners(newDevicesOnly); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#discoverTuners"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **newDevicesOnly** | **Boolean**| Only discover new tuners. | [optional] [default to false] | + +### Return type + +[**List<TunerHostInfo>**](TunerHostInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Tuners returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **discvoverTuners** +> List<TunerHostInfo> discvoverTuners(newDevicesOnly) + +Discover tuners. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + Boolean newDevicesOnly = false; // Boolean | Only discover new tuners. + try { + List result = apiInstance.discvoverTuners(newDevicesOnly); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#discvoverTuners"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **newDevicesOnly** | **Boolean**| Only discover new tuners. | [optional] [default to false] | + +### Return type + +[**List<TunerHostInfo>**](TunerHostInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Tuners returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getChannel** +> BaseItemDto getChannel(channelId, userId) + +Gets a live tv channel. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + UUID channelId = UUID.randomUUID(); // UUID | Channel id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Attach user data. + try { + BaseItemDto result = apiInstance.getChannel(channelId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getChannel"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **channelId** | **UUID**| Channel id. | | +| **userId** | **UUID**| Optional. Attach user data. | [optional] | + +### Return type + +[**BaseItemDto**](BaseItemDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Live tv channel returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getChannelMappingOptions** +> ChannelMappingOptionsDto getChannelMappingOptions(providerId) + +Get channel mapping options. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String providerId = "providerId_example"; // String | Provider id. + try { + ChannelMappingOptionsDto result = apiInstance.getChannelMappingOptions(providerId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getChannelMappingOptions"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **providerId** | **String**| Provider id. | [optional] | + +### Return type + +[**ChannelMappingOptionsDto**](ChannelMappingOptionsDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Channel mapping options returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getDefaultListingProvider** +> ListingsProviderInfo getDefaultListingProvider() + +Gets default listings provider info. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + try { + ListingsProviderInfo result = apiInstance.getDefaultListingProvider(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getDefaultListingProvider"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ListingsProviderInfo**](ListingsProviderInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Default listings provider info returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getDefaultTimer** +> SeriesTimerInfoDto getDefaultTimer(programId) + +Gets the default values for a new timer. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String programId = "programId_example"; // String | Optional. To attach default values based on a program. + try { + SeriesTimerInfoDto result = apiInstance.getDefaultTimer(programId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getDefaultTimer"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **programId** | **String**| Optional. To attach default values based on a program. | [optional] | + +### Return type + +[**SeriesTimerInfoDto**](SeriesTimerInfoDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Default values returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getGuideInfo** +> GuideInfo getGuideInfo() + +Get guid info. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + try { + GuideInfo result = apiInstance.getGuideInfo(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getGuideInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**GuideInfo**](GuideInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Guid info returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getLineups** +> List<NameIdPair> getLineups(id, type, location, country) + +Gets available lineups. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String id = "id_example"; // String | Provider id. + String type = "type_example"; // String | Provider type. + String location = "location_example"; // String | Location. + String country = "country_example"; // String | Country. + try { + List result = apiInstance.getLineups(id, type, location, country); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getLineups"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **id** | **String**| Provider id. | [optional] | +| **type** | **String**| Provider type. | [optional] | +| **location** | **String**| Location. | [optional] | +| **country** | **String**| Country. | [optional] | + +### Return type + +[**List<NameIdPair>**](NameIdPair.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Available lineups returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getLiveRecordingFile** +> File getLiveRecordingFile(recordingId) + +Gets a live tv recording stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String recordingId = "recordingId_example"; // String | Recording id. + try { + File result = apiInstance.getLiveRecordingFile(recordingId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getLiveRecordingFile"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **recordingId** | **String**| Recording id. | | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: video/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Recording stream returned. | - | +| **404** | Recording not found. | - | + + +# **getLiveStreamFile** +> File getLiveStreamFile(streamId, container) + +Gets a live tv channel stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String streamId = "streamId_example"; // String | Stream id. + String container = "container_example"; // String | Container type. + try { + File result = apiInstance.getLiveStreamFile(streamId, container); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getLiveStreamFile"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **streamId** | **String**| Stream id. | | +| **container** | **String**| Container type. | | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: video/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Stream returned. | - | +| **404** | Stream not found. | - | + + +# **getLiveTvChannels** +> BaseItemDtoQueryResult getLiveTvChannels(type, userId, startIndex, isMovie, isSeries, isNews, isKids, isSports, limit, isFavorite, isLiked, isDisliked, enableImages, imageTypeLimit, enableImageTypes, fields, enableUserData, sortBy, sortOrder, enableFavoriteSorting, addCurrentProgram) + +Gets available live tv channels. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + ChannelType type = ChannelType.fromValue("TV"); // ChannelType | Optional. Filter by channel type. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user and attach user data. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Boolean isMovie = true; // Boolean | Optional. Filter for movies. + Boolean isSeries = true; // Boolean | Optional. Filter for series. + Boolean isNews = true; // Boolean | Optional. Filter for news. + Boolean isKids = true; // Boolean | Optional. Filter for kids. + Boolean isSports = true; // Boolean | Optional. Filter for sports. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + Boolean isFavorite = true; // Boolean | Optional. Filter by channels that are favorites, or not. + Boolean isLiked = true; // Boolean | Optional. Filter by channels that are liked, or not. + Boolean isDisliked = true; // Boolean | Optional. Filter by channels that are disliked, or not. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | \"Optional. The image types to include in the output. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + List sortBy = Arrays.asList(); // List | Optional. Key to sort by. + SortOrder sortOrder = SortOrder.fromValue("Ascending"); // SortOrder | Optional. Sort order. + Boolean enableFavoriteSorting = false; // Boolean | Optional. Incorporate favorite and like status into channel sorting. + Boolean addCurrentProgram = true; // Boolean | Optional. Adds current program info to each channel. + try { + BaseItemDtoQueryResult result = apiInstance.getLiveTvChannels(type, userId, startIndex, isMovie, isSeries, isNews, isKids, isSports, limit, isFavorite, isLiked, isDisliked, enableImages, imageTypeLimit, enableImageTypes, fields, enableUserData, sortBy, sortOrder, enableFavoriteSorting, addCurrentProgram); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getLiveTvChannels"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **type** | **ChannelType**| Optional. Filter by channel type. | [optional] [enum: TV, Radio] | +| **userId** | **UUID**| Optional. Filter by user and attach user data. | [optional] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **isMovie** | **Boolean**| Optional. Filter for movies. | [optional] | +| **isSeries** | **Boolean**| Optional. Filter for series. | [optional] | +| **isNews** | **Boolean**| Optional. Filter for news. | [optional] | +| **isKids** | **Boolean**| Optional. Filter for kids. | [optional] | +| **isSports** | **Boolean**| Optional. Filter for sports. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **isFavorite** | **Boolean**| Optional. Filter by channels that are favorites, or not. | [optional] | +| **isLiked** | **Boolean**| Optional. Filter by channels that are liked, or not. | [optional] | +| **isDisliked** | **Boolean**| Optional. Filter by channels that are disliked, or not. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| \"Optional. The image types to include in the output. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **sortBy** | [**List<ItemSortBy>**](ItemSortBy.md)| Optional. Key to sort by. | [optional] | +| **sortOrder** | **SortOrder**| Optional. Sort order. | [optional] [enum: Ascending, Descending] | +| **enableFavoriteSorting** | **Boolean**| Optional. Incorporate favorite and like status into channel sorting. | [optional] [default to false] | +| **addCurrentProgram** | **Boolean**| Optional. Adds current program info to each channel. | [optional] [default to true] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Available live tv channels returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getLiveTvInfo** +> LiveTvInfo getLiveTvInfo() + +Gets available live tv services. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + try { + LiveTvInfo result = apiInstance.getLiveTvInfo(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getLiveTvInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**LiveTvInfo**](LiveTvInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Available live tv services returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getLiveTvPrograms** +> BaseItemDtoQueryResult getLiveTvPrograms(channelIds, userId, minStartDate, hasAired, isAiring, maxStartDate, minEndDate, maxEndDate, isMovie, isSeries, isNews, isKids, isSports, startIndex, limit, sortBy, sortOrder, genres, genreIds, enableImages, imageTypeLimit, enableImageTypes, enableUserData, seriesTimerId, librarySeriesId, fields, enableTotalRecordCount) + +Gets available live tv epgs. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + List channelIds = Arrays.asList(); // List | The channels to return guide information for. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id. + OffsetDateTime minStartDate = OffsetDateTime.now(); // OffsetDateTime | Optional. The minimum premiere start date. + Boolean hasAired = true; // Boolean | Optional. Filter by programs that have completed airing, or not. + Boolean isAiring = true; // Boolean | Optional. Filter by programs that are currently airing, or not. + OffsetDateTime maxStartDate = OffsetDateTime.now(); // OffsetDateTime | Optional. The maximum premiere start date. + OffsetDateTime minEndDate = OffsetDateTime.now(); // OffsetDateTime | Optional. The minimum premiere end date. + OffsetDateTime maxEndDate = OffsetDateTime.now(); // OffsetDateTime | Optional. The maximum premiere end date. + Boolean isMovie = true; // Boolean | Optional. Filter for movies. + Boolean isSeries = true; // Boolean | Optional. Filter for series. + Boolean isNews = true; // Boolean | Optional. Filter for news. + Boolean isKids = true; // Boolean | Optional. Filter for kids. + Boolean isSports = true; // Boolean | Optional. Filter for sports. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List sortBy = Arrays.asList(); // List | Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate. + List sortOrder = Arrays.asList(); // List | Sort Order - Ascending,Descending. + List genres = Arrays.asList(); // List | The genres to return guide information for. + List genreIds = Arrays.asList(); // List | The genre ids to return guide information for. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + String seriesTimerId = "seriesTimerId_example"; // String | Optional. Filter by series timer id. + UUID librarySeriesId = UUID.randomUUID(); // UUID | Optional. Filter by library series id. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + Boolean enableTotalRecordCount = true; // Boolean | Retrieve total record count. + try { + BaseItemDtoQueryResult result = apiInstance.getLiveTvPrograms(channelIds, userId, minStartDate, hasAired, isAiring, maxStartDate, minEndDate, maxEndDate, isMovie, isSeries, isNews, isKids, isSports, startIndex, limit, sortBy, sortOrder, genres, genreIds, enableImages, imageTypeLimit, enableImageTypes, enableUserData, seriesTimerId, librarySeriesId, fields, enableTotalRecordCount); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getLiveTvPrograms"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **channelIds** | [**List<UUID>**](UUID.md)| The channels to return guide information for. | [optional] | +| **userId** | **UUID**| Optional. Filter by user id. | [optional] | +| **minStartDate** | **OffsetDateTime**| Optional. The minimum premiere start date. | [optional] | +| **hasAired** | **Boolean**| Optional. Filter by programs that have completed airing, or not. | [optional] | +| **isAiring** | **Boolean**| Optional. Filter by programs that are currently airing, or not. | [optional] | +| **maxStartDate** | **OffsetDateTime**| Optional. The maximum premiere start date. | [optional] | +| **minEndDate** | **OffsetDateTime**| Optional. The minimum premiere end date. | [optional] | +| **maxEndDate** | **OffsetDateTime**| Optional. The maximum premiere end date. | [optional] | +| **isMovie** | **Boolean**| Optional. Filter for movies. | [optional] | +| **isSeries** | **Boolean**| Optional. Filter for series. | [optional] | +| **isNews** | **Boolean**| Optional. Filter for news. | [optional] | +| **isKids** | **Boolean**| Optional. Filter for kids. | [optional] | +| **isSports** | **Boolean**| Optional. Filter for sports. | [optional] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **sortBy** | [**List<ItemSortBy>**](ItemSortBy.md)| Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate. | [optional] | +| **sortOrder** | [**List<SortOrder>**](SortOrder.md)| Sort Order - Ascending,Descending. | [optional] | +| **genres** | [**List<String>**](String.md)| The genres to return guide information for. | [optional] | +| **genreIds** | [**List<UUID>**](UUID.md)| The genre ids to return guide information for. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **seriesTimerId** | **String**| Optional. Filter by series timer id. | [optional] | +| **librarySeriesId** | **UUID**| Optional. Filter by library series id. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **enableTotalRecordCount** | **Boolean**| Retrieve total record count. | [optional] [default to true] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Live tv epgs returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getProgram** +> BaseItemDto getProgram(programId, userId) + +Gets a live tv program. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String programId = "programId_example"; // String | Program id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Attach user data. + try { + BaseItemDto result = apiInstance.getProgram(programId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getProgram"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **programId** | **String**| Program id. | | +| **userId** | **UUID**| Optional. Attach user data. | [optional] | + +### Return type + +[**BaseItemDto**](BaseItemDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Program returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPrograms** +> BaseItemDtoQueryResult getPrograms(getProgramsDto) + +Gets available live tv epgs. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + GetProgramsDto getProgramsDto = new GetProgramsDto(); // GetProgramsDto | Request body. + try { + BaseItemDtoQueryResult result = apiInstance.getPrograms(getProgramsDto); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getPrograms"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **getProgramsDto** | [**GetProgramsDto**](GetProgramsDto.md)| Request body. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Live tv epgs returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getRecommendedPrograms** +> BaseItemDtoQueryResult getRecommendedPrograms(userId, limit, isAiring, hasAired, isSeries, isMovie, isNews, isKids, isSports, enableImages, imageTypeLimit, enableImageTypes, genreIds, fields, enableUserData, enableTotalRecordCount) + +Gets recommended live tv epgs. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | Optional. filter by user id. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + Boolean isAiring = true; // Boolean | Optional. Filter by programs that are currently airing, or not. + Boolean hasAired = true; // Boolean | Optional. Filter by programs that have completed airing, or not. + Boolean isSeries = true; // Boolean | Optional. Filter for series. + Boolean isMovie = true; // Boolean | Optional. Filter for movies. + Boolean isNews = true; // Boolean | Optional. Filter for news. + Boolean isKids = true; // Boolean | Optional. Filter for kids. + Boolean isSports = true; // Boolean | Optional. Filter for sports. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + List genreIds = Arrays.asList(); // List | The genres to return guide information for. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + Boolean enableUserData = true; // Boolean | Optional. include user data. + Boolean enableTotalRecordCount = true; // Boolean | Retrieve total record count. + try { + BaseItemDtoQueryResult result = apiInstance.getRecommendedPrograms(userId, limit, isAiring, hasAired, isSeries, isMovie, isNews, isKids, isSports, enableImages, imageTypeLimit, enableImageTypes, genreIds, fields, enableUserData, enableTotalRecordCount); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getRecommendedPrograms"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| Optional. filter by user id. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **isAiring** | **Boolean**| Optional. Filter by programs that are currently airing, or not. | [optional] | +| **hasAired** | **Boolean**| Optional. Filter by programs that have completed airing, or not. | [optional] | +| **isSeries** | **Boolean**| Optional. Filter for series. | [optional] | +| **isMovie** | **Boolean**| Optional. Filter for movies. | [optional] | +| **isNews** | **Boolean**| Optional. Filter for news. | [optional] | +| **isKids** | **Boolean**| Optional. Filter for kids. | [optional] | +| **isSports** | **Boolean**| Optional. Filter for sports. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **genreIds** | [**List<UUID>**](UUID.md)| The genres to return guide information for. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **enableUserData** | **Boolean**| Optional. include user data. | [optional] | +| **enableTotalRecordCount** | **Boolean**| Retrieve total record count. | [optional] [default to true] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Recommended epgs returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getRecording** +> BaseItemDto getRecording(recordingId, userId) + +Gets a live tv recording. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + UUID recordingId = UUID.randomUUID(); // UUID | Recording id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Attach user data. + try { + BaseItemDto result = apiInstance.getRecording(recordingId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getRecording"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **recordingId** | **UUID**| Recording id. | | +| **userId** | **UUID**| Optional. Attach user data. | [optional] | + +### Return type + +[**BaseItemDto**](BaseItemDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Recording returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getRecordingFolders** +> BaseItemDtoQueryResult getRecordingFolders(userId) + +Gets recording folders. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user and attach user data. + try { + BaseItemDtoQueryResult result = apiInstance.getRecordingFolders(userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getRecordingFolders"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| Optional. Filter by user and attach user data. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Recording folders returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getRecordingGroup** +> getRecordingGroup(groupId) + +Get recording group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + UUID groupId = UUID.randomUUID(); // UUID | Group id. + try { + apiInstance.getRecordingGroup(groupId); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getRecordingGroup"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **groupId** | **UUID**| Group id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **404** | Not Found | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getRecordingGroups** +> BaseItemDtoQueryResult getRecordingGroups(userId) + +Gets live tv recording groups. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user and attach user data. + try { + BaseItemDtoQueryResult result = apiInstance.getRecordingGroups(userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getRecordingGroups"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| Optional. Filter by user and attach user data. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Recording groups returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getRecordings** +> BaseItemDtoQueryResult getRecordings(channelId, userId, startIndex, limit, status, isInProgress, seriesTimerId, enableImages, imageTypeLimit, enableImageTypes, fields, enableUserData, isMovie, isSeries, isKids, isSports, isNews, isLibraryItem, enableTotalRecordCount) + +Gets live tv recordings. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String channelId = "channelId_example"; // String | Optional. Filter by channel id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user and attach user data. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + RecordingStatus status = RecordingStatus.fromValue("New"); // RecordingStatus | Optional. Filter by recording status. + Boolean isInProgress = true; // Boolean | Optional. Filter by recordings that are in progress, or not. + String seriesTimerId = "seriesTimerId_example"; // String | Optional. Filter by recordings belonging to a series timer. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + Boolean isMovie = true; // Boolean | Optional. Filter for movies. + Boolean isSeries = true; // Boolean | Optional. Filter for series. + Boolean isKids = true; // Boolean | Optional. Filter for kids. + Boolean isSports = true; // Boolean | Optional. Filter for sports. + Boolean isNews = true; // Boolean | Optional. Filter for news. + Boolean isLibraryItem = true; // Boolean | Optional. Filter for is library item. + Boolean enableTotalRecordCount = true; // Boolean | Optional. Return total record count. + try { + BaseItemDtoQueryResult result = apiInstance.getRecordings(channelId, userId, startIndex, limit, status, isInProgress, seriesTimerId, enableImages, imageTypeLimit, enableImageTypes, fields, enableUserData, isMovie, isSeries, isKids, isSports, isNews, isLibraryItem, enableTotalRecordCount); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getRecordings"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **channelId** | **String**| Optional. Filter by channel id. | [optional] | +| **userId** | **UUID**| Optional. Filter by user and attach user data. | [optional] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **status** | **RecordingStatus**| Optional. Filter by recording status. | [optional] [enum: New, InProgress, Completed, Cancelled, ConflictedOk, ConflictedNotOk, Error] | +| **isInProgress** | **Boolean**| Optional. Filter by recordings that are in progress, or not. | [optional] | +| **seriesTimerId** | **String**| Optional. Filter by recordings belonging to a series timer. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **isMovie** | **Boolean**| Optional. Filter for movies. | [optional] | +| **isSeries** | **Boolean**| Optional. Filter for series. | [optional] | +| **isKids** | **Boolean**| Optional. Filter for kids. | [optional] | +| **isSports** | **Boolean**| Optional. Filter for sports. | [optional] | +| **isNews** | **Boolean**| Optional. Filter for news. | [optional] | +| **isLibraryItem** | **Boolean**| Optional. Filter for is library item. | [optional] | +| **enableTotalRecordCount** | **Boolean**| Optional. Return total record count. | [optional] [default to true] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Live tv recordings returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getRecordingsSeries** +> BaseItemDtoQueryResult getRecordingsSeries(channelId, userId, groupId, startIndex, limit, status, isInProgress, seriesTimerId, enableImages, imageTypeLimit, enableImageTypes, fields, enableUserData, enableTotalRecordCount) + +Gets live tv recording series. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String channelId = "channelId_example"; // String | Optional. Filter by channel id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user and attach user data. + String groupId = "groupId_example"; // String | Optional. Filter by recording group. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + RecordingStatus status = RecordingStatus.fromValue("New"); // RecordingStatus | Optional. Filter by recording status. + Boolean isInProgress = true; // Boolean | Optional. Filter by recordings that are in progress, or not. + String seriesTimerId = "seriesTimerId_example"; // String | Optional. Filter by recordings belonging to a series timer. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + Boolean enableTotalRecordCount = true; // Boolean | Optional. Return total record count. + try { + BaseItemDtoQueryResult result = apiInstance.getRecordingsSeries(channelId, userId, groupId, startIndex, limit, status, isInProgress, seriesTimerId, enableImages, imageTypeLimit, enableImageTypes, fields, enableUserData, enableTotalRecordCount); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getRecordingsSeries"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **channelId** | **String**| Optional. Filter by channel id. | [optional] | +| **userId** | **UUID**| Optional. Filter by user and attach user data. | [optional] | +| **groupId** | **String**| Optional. Filter by recording group. | [optional] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **status** | **RecordingStatus**| Optional. Filter by recording status. | [optional] [enum: New, InProgress, Completed, Cancelled, ConflictedOk, ConflictedNotOk, Error] | +| **isInProgress** | **Boolean**| Optional. Filter by recordings that are in progress, or not. | [optional] | +| **seriesTimerId** | **String**| Optional. Filter by recordings belonging to a series timer. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **enableTotalRecordCount** | **Boolean**| Optional. Return total record count. | [optional] [default to true] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Live tv recordings returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getSchedulesDirectCountries** +> File getSchedulesDirectCountries() + +Gets available countries. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + try { + File result = apiInstance.getSchedulesDirectCountries(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getSchedulesDirectCountries"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Available countries returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getSeriesTimer** +> SeriesTimerInfoDto getSeriesTimer(timerId) + +Gets a live tv series timer. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String timerId = "timerId_example"; // String | Timer id. + try { + SeriesTimerInfoDto result = apiInstance.getSeriesTimer(timerId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getSeriesTimer"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **timerId** | **String**| Timer id. | | + +### Return type + +[**SeriesTimerInfoDto**](SeriesTimerInfoDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Series timer returned. | - | +| **404** | Series timer not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getSeriesTimers** +> SeriesTimerInfoDtoQueryResult getSeriesTimers(sortBy, sortOrder) + +Gets live tv series timers. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String sortBy = "sortBy_example"; // String | Optional. Sort by SortName or Priority. + SortOrder sortOrder = SortOrder.fromValue("Ascending"); // SortOrder | Optional. Sort in Ascending or Descending order. + try { + SeriesTimerInfoDtoQueryResult result = apiInstance.getSeriesTimers(sortBy, sortOrder); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getSeriesTimers"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **sortBy** | **String**| Optional. Sort by SortName or Priority. | [optional] | +| **sortOrder** | **SortOrder**| Optional. Sort in Ascending or Descending order. | [optional] [enum: Ascending, Descending] | + +### Return type + +[**SeriesTimerInfoDtoQueryResult**](SeriesTimerInfoDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Timers returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getTimer** +> TimerInfoDto getTimer(timerId) + +Gets a timer. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String timerId = "timerId_example"; // String | Timer id. + try { + TimerInfoDto result = apiInstance.getTimer(timerId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getTimer"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **timerId** | **String**| Timer id. | | + +### Return type + +[**TimerInfoDto**](TimerInfoDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Timer returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getTimers** +> TimerInfoDtoQueryResult getTimers(channelId, seriesTimerId, isActive, isScheduled) + +Gets the live tv timers. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String channelId = "channelId_example"; // String | Optional. Filter by channel id. + String seriesTimerId = "seriesTimerId_example"; // String | Optional. Filter by timers belonging to a series timer. + Boolean isActive = true; // Boolean | Optional. Filter by timers that are active. + Boolean isScheduled = true; // Boolean | Optional. Filter by timers that are scheduled. + try { + TimerInfoDtoQueryResult result = apiInstance.getTimers(channelId, seriesTimerId, isActive, isScheduled); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getTimers"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **channelId** | **String**| Optional. Filter by channel id. | [optional] | +| **seriesTimerId** | **String**| Optional. Filter by timers belonging to a series timer. | [optional] | +| **isActive** | **Boolean**| Optional. Filter by timers that are active. | [optional] | +| **isScheduled** | **Boolean**| Optional. Filter by timers that are scheduled. | [optional] | + +### Return type + +[**TimerInfoDtoQueryResult**](TimerInfoDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getTunerHostTypes** +> List<NameIdPair> getTunerHostTypes() + +Get tuner host types. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + try { + List result = apiInstance.getTunerHostTypes(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#getTunerHostTypes"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<NameIdPair>**](NameIdPair.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Tuner host types returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **resetTuner** +> resetTuner(tunerId) + +Resets a tv tuner. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String tunerId = "tunerId_example"; // String | Tuner id. + try { + apiInstance.resetTuner(tunerId); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#resetTuner"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **tunerId** | **String**| Tuner id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Tuner reset. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **setChannelMapping** +> TunerChannelMapping setChannelMapping(setChannelMappingDto) + +Set channel mappings. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + SetChannelMappingDto setChannelMappingDto = new SetChannelMappingDto(); // SetChannelMappingDto | The set channel mapping dto. + try { + TunerChannelMapping result = apiInstance.setChannelMapping(setChannelMappingDto); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#setChannelMapping"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **setChannelMappingDto** | [**SetChannelMappingDto**](SetChannelMappingDto.md)| The set channel mapping dto. | | + +### Return type + +[**TunerChannelMapping**](TunerChannelMapping.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Created channel mapping returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateSeriesTimer** +> updateSeriesTimer(timerId, seriesTimerInfoDto) + +Updates a live tv series timer. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String timerId = "timerId_example"; // String | Timer id. + SeriesTimerInfoDto seriesTimerInfoDto = new SeriesTimerInfoDto(); // SeriesTimerInfoDto | New series timer info. + try { + apiInstance.updateSeriesTimer(timerId, seriesTimerInfoDto); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#updateSeriesTimer"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **timerId** | **String**| Timer id. | | +| **seriesTimerInfoDto** | [**SeriesTimerInfoDto**](SeriesTimerInfoDto.md)| New series timer info. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Series timer updated. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateTimer** +> updateTimer(timerId, timerInfoDto) + +Updates a live tv timer. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LiveTvApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LiveTvApi apiInstance = new LiveTvApi(defaultClient); + String timerId = "timerId_example"; // String | Timer id. + TimerInfoDto timerInfoDto = new TimerInfoDto(); // TimerInfoDto | New timer info. + try { + apiInstance.updateTimer(timerId, timerInfoDto); + } catch (ApiException e) { + System.err.println("Exception when calling LiveTvApi#updateTimer"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **timerId** | **String**| Timer id. | | +| **timerInfoDto** | [**TimerInfoDto**](TimerInfoDto.md)| New timer info. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Timer updated. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LiveTvInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LiveTvInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LiveTvInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LiveTvInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/LiveTvOptions.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LiveTvOptions.md similarity index 89% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/LiveTvOptions.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LiveTvOptions.md index e37a859ee17d9..13bf496ac87aa 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/LiveTvOptions.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LiveTvOptions.md @@ -20,6 +20,8 @@ |**mediaLocationsCreated** | **List<String>** | | [optional] | |**recordingPostProcessor** | **String** | | [optional] | |**recordingPostProcessorArguments** | **String** | | [optional] | +|**saveRecordingNFO** | **Boolean** | | [optional] | +|**saveRecordingImages** | **Boolean** | | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LiveTvServiceInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LiveTvServiceInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LiveTvServiceInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LiveTvServiceInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LiveTvServiceStatus.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LiveTvServiceStatus.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LiveTvServiceStatus.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LiveTvServiceStatus.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LocalizationApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LocalizationApi.md new file mode 100644 index 0000000000000..2ddb03f71418e --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LocalizationApi.md @@ -0,0 +1,272 @@ +# LocalizationApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getCountries**](LocalizationApi.md#getCountries) | **GET** /Localization/Countries | Gets known countries. | +| [**getCultures**](LocalizationApi.md#getCultures) | **GET** /Localization/Cultures | Gets known cultures. | +| [**getLocalizationOptions**](LocalizationApi.md#getLocalizationOptions) | **GET** /Localization/Options | Gets localization options. | +| [**getParentalRatings**](LocalizationApi.md#getParentalRatings) | **GET** /Localization/ParentalRatings | Gets known parental ratings. | + + + +# **getCountries** +> List<CountryInfo> getCountries() + +Gets known countries. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LocalizationApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LocalizationApi apiInstance = new LocalizationApi(defaultClient); + try { + List result = apiInstance.getCountries(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LocalizationApi#getCountries"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<CountryInfo>**](CountryInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Known countries returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getCultures** +> List<CultureDto> getCultures() + +Gets known cultures. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LocalizationApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LocalizationApi apiInstance = new LocalizationApi(defaultClient); + try { + List result = apiInstance.getCultures(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LocalizationApi#getCultures"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<CultureDto>**](CultureDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Known cultures returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getLocalizationOptions** +> List<LocalizationOption> getLocalizationOptions() + +Gets localization options. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LocalizationApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LocalizationApi apiInstance = new LocalizationApi(defaultClient); + try { + List result = apiInstance.getLocalizationOptions(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LocalizationApi#getLocalizationOptions"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<LocalizationOption>**](LocalizationOption.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Localization options returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getParentalRatings** +> List<ParentalRating> getParentalRatings() + +Gets known parental ratings. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LocalizationApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LocalizationApi apiInstance = new LocalizationApi(defaultClient); + try { + List result = apiInstance.getParentalRatings(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LocalizationApi#getParentalRatings"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<ParentalRating>**](ParentalRating.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Known parental ratings returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LocalizationOption.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LocalizationOption.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LocalizationOption.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LocalizationOption.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LocationType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LocationType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LocationType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LocationType.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LogFile.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LogFile.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LogFile.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LogFile.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LogLevel.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LogLevel.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/LogLevel.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LogLevel.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LyricDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LyricDto.md new file mode 100644 index 0000000000000..3e378d2442122 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LyricDto.md @@ -0,0 +1,15 @@ + + +# LyricDto + +LyricResponse model. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**metadata** | [**LyricMetadata**](LyricMetadata.md) | Gets or sets Metadata for the lyrics. | [optional] | +|**lyrics** | [**List<LyricLine>**](LyricLine.md) | Gets or sets a collection of individual lyric lines. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LyricLine.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LyricLine.md new file mode 100644 index 0000000000000..392902684ca7f --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LyricLine.md @@ -0,0 +1,15 @@ + + +# LyricLine + +Lyric model. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**text** | **String** | Gets the text of this lyric line. | [optional] | +|**start** | **Long** | Gets the start time in ticks. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LyricMetadata.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LyricMetadata.md new file mode 100644 index 0000000000000..aa2df97d3f2ec --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LyricMetadata.md @@ -0,0 +1,23 @@ + + +# LyricMetadata + +LyricMetadata model. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**artist** | **String** | Gets or sets the song artist. | [optional] | +|**album** | **String** | Gets or sets the album this song is on. | [optional] | +|**title** | **String** | Gets or sets the title of the song. | [optional] | +|**author** | **String** | Gets or sets the author of the lyric data. | [optional] | +|**length** | **Long** | Gets or sets the length of the song in ticks. | [optional] | +|**by** | **String** | Gets or sets who the LRC file was created by. | [optional] | +|**offset** | **Long** | Gets or sets the lyric offset compared to audio in ticks. | [optional] | +|**creator** | **String** | Gets or sets the software used to create the LRC file. | [optional] | +|**version** | **String** | Gets or sets the version of the creator used. | [optional] | +|**isSynced** | **Boolean** | Gets or sets a value indicating whether this lyric is synced. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LyricsApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LyricsApi.md new file mode 100644 index 0000000000000..71773873e169c --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/LyricsApi.md @@ -0,0 +1,440 @@ +# LyricsApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**deleteLyrics**](LyricsApi.md#deleteLyrics) | **DELETE** /Audio/{itemId}/Lyrics | Deletes an external lyric file. | +| [**downloadRemoteLyrics**](LyricsApi.md#downloadRemoteLyrics) | **POST** /Audio/{itemId}/RemoteSearch/Lyrics/{lyricId} | Downloads a remote lyric. | +| [**getLyrics**](LyricsApi.md#getLyrics) | **GET** /Audio/{itemId}/Lyrics | Gets an item's lyrics. | +| [**getRemoteLyrics**](LyricsApi.md#getRemoteLyrics) | **GET** /Providers/Lyrics/{lyricId} | Gets the remote lyrics. | +| [**searchRemoteLyrics**](LyricsApi.md#searchRemoteLyrics) | **GET** /Audio/{itemId}/RemoteSearch/Lyrics | Search remote lyrics. | +| [**uploadLyrics**](LyricsApi.md#uploadLyrics) | **POST** /Audio/{itemId}/Lyrics | Upload an external lyric file. | + + + +# **deleteLyrics** +> deleteLyrics(itemId) + +Deletes an external lyric file. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LyricsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LyricsApi apiInstance = new LyricsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + try { + apiInstance.deleteLyrics(itemId); + } catch (ApiException e) { + System.err.println("Exception when calling LyricsApi#deleteLyrics"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Lyric deleted. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **downloadRemoteLyrics** +> LyricDto downloadRemoteLyrics(itemId, lyricId) + +Downloads a remote lyric. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LyricsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LyricsApi apiInstance = new LyricsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String lyricId = "lyricId_example"; // String | The lyric id. + try { + LyricDto result = apiInstance.downloadRemoteLyrics(itemId, lyricId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LyricsApi#downloadRemoteLyrics"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **lyricId** | **String**| The lyric id. | | + +### Return type + +[**LyricDto**](LyricDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Lyric downloaded. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getLyrics** +> LyricDto getLyrics(itemId) + +Gets an item's lyrics. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LyricsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LyricsApi apiInstance = new LyricsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + try { + LyricDto result = apiInstance.getLyrics(itemId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LyricsApi#getLyrics"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | + +### Return type + +[**LyricDto**](LyricDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Lyrics returned. | - | +| **404** | Something went wrong. No Lyrics will be returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getRemoteLyrics** +> LyricDto getRemoteLyrics(lyricId) + +Gets the remote lyrics. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LyricsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LyricsApi apiInstance = new LyricsApi(defaultClient); + String lyricId = "lyricId_example"; // String | The remote provider item id. + try { + LyricDto result = apiInstance.getRemoteLyrics(lyricId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LyricsApi#getRemoteLyrics"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **lyricId** | **String**| The remote provider item id. | | + +### Return type + +[**LyricDto**](LyricDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | File returned. | - | +| **404** | Lyric not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **searchRemoteLyrics** +> List<RemoteLyricInfoDto> searchRemoteLyrics(itemId) + +Search remote lyrics. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LyricsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LyricsApi apiInstance = new LyricsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + try { + List result = apiInstance.searchRemoteLyrics(itemId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LyricsApi#searchRemoteLyrics"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | + +### Return type + +[**List<RemoteLyricInfoDto>**](RemoteLyricInfoDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Lyrics retrieved. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **uploadLyrics** +> LyricDto uploadLyrics(itemId, fileName, body) + +Upload an external lyric file. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.LyricsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + LyricsApi apiInstance = new LyricsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item the lyric belongs to. + String fileName = "fileName_example"; // String | Name of the file being uploaded. + File body = new File("/path/to/file"); // File | + try { + LyricDto result = apiInstance.uploadLyrics(itemId, fileName, body); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LyricsApi#uploadLyrics"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item the lyric belongs to. | | +| **fileName** | **String**| Name of the file being uploaded. | | +| **body** | **File**| | [optional] | + +### Return type + +[**LyricDto**](LyricDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: text/plain + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Lyrics uploaded. | - | +| **400** | Error processing upload. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MediaAttachment.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaAttachment.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MediaAttachment.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaAttachment.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaInfoApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaInfoApi.md new file mode 100644 index 0000000000000..d37f770f76b5a --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaInfoApi.md @@ -0,0 +1,417 @@ +# MediaInfoApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**closeLiveStream**](MediaInfoApi.md#closeLiveStream) | **POST** /LiveStreams/Close | Closes a media source. | +| [**getBitrateTestBytes**](MediaInfoApi.md#getBitrateTestBytes) | **GET** /Playback/BitrateTest | Tests the network with a request with the size of the bitrate. | +| [**getPlaybackInfo**](MediaInfoApi.md#getPlaybackInfo) | **GET** /Items/{itemId}/PlaybackInfo | Gets live playback media info for an item. | +| [**getPostedPlaybackInfo**](MediaInfoApi.md#getPostedPlaybackInfo) | **POST** /Items/{itemId}/PlaybackInfo | Gets live playback media info for an item. | +| [**openLiveStream**](MediaInfoApi.md#openLiveStream) | **POST** /LiveStreams/Open | Opens a media source. | + + + +# **closeLiveStream** +> closeLiveStream(liveStreamId) + +Closes a media source. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.MediaInfoApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + MediaInfoApi apiInstance = new MediaInfoApi(defaultClient); + String liveStreamId = "liveStreamId_example"; // String | The livestream id. + try { + apiInstance.closeLiveStream(liveStreamId); + } catch (ApiException e) { + System.err.println("Exception when calling MediaInfoApi#closeLiveStream"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **liveStreamId** | **String**| The livestream id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Livestream closed. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getBitrateTestBytes** +> File getBitrateTestBytes(size) + +Tests the network with a request with the size of the bitrate. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.MediaInfoApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + MediaInfoApi apiInstance = new MediaInfoApi(defaultClient); + Integer size = 102400; // Integer | The bitrate. Defaults to 102400. + try { + File result = apiInstance.getBitrateTestBytes(size); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling MediaInfoApi#getBitrateTestBytes"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **size** | **Integer**| The bitrate. Defaults to 102400. | [optional] [default to 102400] | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Test buffer returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPlaybackInfo** +> PlaybackInfoResponse getPlaybackInfo(itemId, userId) + +Gets live playback media info for an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.MediaInfoApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + MediaInfoApi apiInstance = new MediaInfoApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + UUID userId = UUID.randomUUID(); // UUID | The user id. + try { + PlaybackInfoResponse result = apiInstance.getPlaybackInfo(itemId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling MediaInfoApi#getPlaybackInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **userId** | **UUID**| The user id. | [optional] | + +### Return type + +[**PlaybackInfoResponse**](PlaybackInfoResponse.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Playback info returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPostedPlaybackInfo** +> PlaybackInfoResponse getPostedPlaybackInfo(itemId, userId, maxStreamingBitrate, startTimeTicks, audioStreamIndex, subtitleStreamIndex, maxAudioChannels, mediaSourceId, liveStreamId, autoOpenLiveStream, enableDirectPlay, enableDirectStream, enableTranscoding, allowVideoStreamCopy, allowAudioStreamCopy, playbackInfoDto) + +Gets live playback media info for an item. + +For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.MediaInfoApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + MediaInfoApi apiInstance = new MediaInfoApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + UUID userId = UUID.randomUUID(); // UUID | The user id. + Integer maxStreamingBitrate = 56; // Integer | The maximum streaming bitrate. + Long startTimeTicks = 56L; // Long | The start time in ticks. + Integer audioStreamIndex = 56; // Integer | The audio stream index. + Integer subtitleStreamIndex = 56; // Integer | The subtitle stream index. + Integer maxAudioChannels = 56; // Integer | The maximum number of audio channels. + String mediaSourceId = "mediaSourceId_example"; // String | The media source id. + String liveStreamId = "liveStreamId_example"; // String | The livestream id. + Boolean autoOpenLiveStream = true; // Boolean | Whether to auto open the livestream. + Boolean enableDirectPlay = true; // Boolean | Whether to enable direct play. Default: true. + Boolean enableDirectStream = true; // Boolean | Whether to enable direct stream. Default: true. + Boolean enableTranscoding = true; // Boolean | Whether to enable transcoding. Default: true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether to allow to copy the video stream. Default: true. + Boolean allowAudioStreamCopy = true; // Boolean | Whether to allow to copy the audio stream. Default: true. + PlaybackInfoDto playbackInfoDto = new PlaybackInfoDto(); // PlaybackInfoDto | The playback info. + try { + PlaybackInfoResponse result = apiInstance.getPostedPlaybackInfo(itemId, userId, maxStreamingBitrate, startTimeTicks, audioStreamIndex, subtitleStreamIndex, maxAudioChannels, mediaSourceId, liveStreamId, autoOpenLiveStream, enableDirectPlay, enableDirectStream, enableTranscoding, allowVideoStreamCopy, allowAudioStreamCopy, playbackInfoDto); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling MediaInfoApi#getPostedPlaybackInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **userId** | **UUID**| The user id. | [optional] | +| **maxStreamingBitrate** | **Integer**| The maximum streaming bitrate. | [optional] | +| **startTimeTicks** | **Long**| The start time in ticks. | [optional] | +| **audioStreamIndex** | **Integer**| The audio stream index. | [optional] | +| **subtitleStreamIndex** | **Integer**| The subtitle stream index. | [optional] | +| **maxAudioChannels** | **Integer**| The maximum number of audio channels. | [optional] | +| **mediaSourceId** | **String**| The media source id. | [optional] | +| **liveStreamId** | **String**| The livestream id. | [optional] | +| **autoOpenLiveStream** | **Boolean**| Whether to auto open the livestream. | [optional] | +| **enableDirectPlay** | **Boolean**| Whether to enable direct play. Default: true. | [optional] | +| **enableDirectStream** | **Boolean**| Whether to enable direct stream. Default: true. | [optional] | +| **enableTranscoding** | **Boolean**| Whether to enable transcoding. Default: true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether to allow to copy the video stream. Default: true. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether to allow to copy the audio stream. Default: true. | [optional] | +| **playbackInfoDto** | [**PlaybackInfoDto**](PlaybackInfoDto.md)| The playback info. | [optional] | + +### Return type + +[**PlaybackInfoResponse**](PlaybackInfoResponse.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Playback info returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **openLiveStream** +> LiveStreamResponse openLiveStream(openToken, userId, playSessionId, maxStreamingBitrate, startTimeTicks, audioStreamIndex, subtitleStreamIndex, maxAudioChannels, itemId, enableDirectPlay, enableDirectStream, alwaysBurnInSubtitleWhenTranscoding, openLiveStreamDto) + +Opens a media source. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.MediaInfoApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + MediaInfoApi apiInstance = new MediaInfoApi(defaultClient); + String openToken = "openToken_example"; // String | The open token. + UUID userId = UUID.randomUUID(); // UUID | The user id. + String playSessionId = "playSessionId_example"; // String | The play session id. + Integer maxStreamingBitrate = 56; // Integer | The maximum streaming bitrate. + Long startTimeTicks = 56L; // Long | The start time in ticks. + Integer audioStreamIndex = 56; // Integer | The audio stream index. + Integer subtitleStreamIndex = 56; // Integer | The subtitle stream index. + Integer maxAudioChannels = 56; // Integer | The maximum number of audio channels. + UUID itemId = UUID.randomUUID(); // UUID | The item id. + Boolean enableDirectPlay = true; // Boolean | Whether to enable direct play. Default: true. + Boolean enableDirectStream = true; // Boolean | Whether to enable direct stream. Default: true. + Boolean alwaysBurnInSubtitleWhenTranscoding = true; // Boolean | Always burn-in subtitle when transcoding. + OpenLiveStreamDto openLiveStreamDto = new OpenLiveStreamDto(); // OpenLiveStreamDto | The open live stream dto. + try { + LiveStreamResponse result = apiInstance.openLiveStream(openToken, userId, playSessionId, maxStreamingBitrate, startTimeTicks, audioStreamIndex, subtitleStreamIndex, maxAudioChannels, itemId, enableDirectPlay, enableDirectStream, alwaysBurnInSubtitleWhenTranscoding, openLiveStreamDto); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling MediaInfoApi#openLiveStream"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **openToken** | **String**| The open token. | [optional] | +| **userId** | **UUID**| The user id. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **maxStreamingBitrate** | **Integer**| The maximum streaming bitrate. | [optional] | +| **startTimeTicks** | **Long**| The start time in ticks. | [optional] | +| **audioStreamIndex** | **Integer**| The audio stream index. | [optional] | +| **subtitleStreamIndex** | **Integer**| The subtitle stream index. | [optional] | +| **maxAudioChannels** | **Integer**| The maximum number of audio channels. | [optional] | +| **itemId** | **UUID**| The item id. | [optional] | +| **enableDirectPlay** | **Boolean**| Whether to enable direct play. Default: true. | [optional] | +| **enableDirectStream** | **Boolean**| Whether to enable direct stream. Default: true. | [optional] | +| **alwaysBurnInSubtitleWhenTranscoding** | **Boolean**| Always burn-in subtitle when transcoding. | [optional] | +| **openLiveStreamDto** | [**OpenLiveStreamDto**](OpenLiveStreamDto.md)| The open live stream dto. | [optional] | + +### Return type + +[**LiveStreamResponse**](LiveStreamResponse.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Media source opened. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MediaPathDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaPathDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MediaPathDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaPathDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/MediaPathInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaPathInfo.md similarity index 78% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/MediaPathInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaPathInfo.md index e3f828be989be..927dc8cfac2fc 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/MediaPathInfo.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaPathInfo.md @@ -8,7 +8,6 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| |**path** | **String** | | [optional] | -|**networkPath** | **String** | | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MediaProtocol.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaProtocol.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MediaProtocol.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaProtocol.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSegmentDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSegmentDto.md new file mode 100644 index 0000000000000..93bf630c630e8 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSegmentDto.md @@ -0,0 +1,18 @@ + + +# MediaSegmentDto + +Api model for MediaSegment's. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**id** | **UUID** | Gets or sets the id of the media segment. | [optional] | +|**itemId** | **UUID** | Gets or sets the id of the associated item. | [optional] | +|**type** | **MediaSegmentType** | Defines the types of content an individual Jellyfin.Data.Entities.MediaSegment represents. | [optional] | +|**startTicks** | **Long** | Gets or sets the start of the segment. | [optional] | +|**endTicks** | **Long** | Gets or sets the end of the segment. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSegmentDtoQueryResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSegmentDtoQueryResult.md new file mode 100644 index 0000000000000..29ad7959e1488 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSegmentDtoQueryResult.md @@ -0,0 +1,16 @@ + + +# MediaSegmentDtoQueryResult + +Query result container. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**items** | [**List<MediaSegmentDto>**](MediaSegmentDto.md) | Gets or sets the items. | [optional] | +|**totalRecordCount** | **Integer** | Gets or sets the total number of records available. | [optional] | +|**startIndex** | **Integer** | Gets or sets the index of the first record in Items. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSegmentType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSegmentType.md new file mode 100644 index 0000000000000..c8e2fb3ae9a21 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSegmentType.md @@ -0,0 +1,21 @@ + + +# MediaSegmentType + +## Enum + + +* `UNKNOWN` (value: `"Unknown"`) + +* `COMMERCIAL` (value: `"Commercial"`) + +* `PREVIEW` (value: `"Preview"`) + +* `RECAP` (value: `"Recap"`) + +* `OUTRO` (value: `"Outro"`) + +* `INTRO` (value: `"Intro"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSegmentsApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSegmentsApi.md new file mode 100644 index 0000000000000..ffc0025918ab6 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSegmentsApi.md @@ -0,0 +1,81 @@ +# MediaSegmentsApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getItemSegments**](MediaSegmentsApi.md#getItemSegments) | **GET** /MediaSegments/{itemId} | Gets all media segments based on an itemId. | + + + +# **getItemSegments** +> MediaSegmentDtoQueryResult getItemSegments(itemId, includeSegmentTypes) + +Gets all media segments based on an itemId. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.MediaSegmentsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + MediaSegmentsApi apiInstance = new MediaSegmentsApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The ItemId. + List includeSegmentTypes = Arrays.asList(); // List | Optional filter of requested segment types. + try { + MediaSegmentDtoQueryResult result = apiInstance.getItemSegments(itemId, includeSegmentTypes); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling MediaSegmentsApi#getItemSegments"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The ItemId. | | +| **includeSegmentTypes** | [**List<MediaSegmentType>**](MediaSegmentType.md)| Optional filter of requested segment types. | [optional] | + +### Return type + +[**MediaSegmentDtoQueryResult**](MediaSegmentDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | +| **404** | Not Found | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/MediaSourceInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSourceInfo.md similarity index 88% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/MediaSourceInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSourceInfo.md index 799c8ebf35370..c584762d9721a 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/MediaSourceInfo.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSourceInfo.md @@ -27,6 +27,7 @@ |**supportsDirectStream** | **Boolean** | | [optional] | |**supportsDirectPlay** | **Boolean** | | [optional] | |**isInfiniteStream** | **Boolean** | | [optional] | +|**useMostCompatibleTranscodingProfile** | **Boolean** | | [optional] | |**requiresOpening** | **Boolean** | | [optional] | |**openToken** | **String** | | [optional] | |**requiresClosing** | **Boolean** | | [optional] | @@ -41,14 +42,16 @@ |**mediaAttachments** | [**List<MediaAttachment>**](MediaAttachment.md) | | [optional] | |**formats** | **List<String>** | | [optional] | |**bitrate** | **Integer** | | [optional] | +|**fallbackMaxStreamingBitrate** | **Integer** | | [optional] | |**timestamp** | **TransportStreamTimestamp** | | [optional] | |**requiredHttpHeaders** | **Map<String, String>** | | [optional] | |**transcodingUrl** | **String** | | [optional] | -|**transcodingSubProtocol** | **String** | | [optional] | +|**transcodingSubProtocol** | **MediaStreamProtocol** | Media streaming protocol. Lowercase for backwards compatibility. | [optional] | |**transcodingContainer** | **String** | | [optional] | |**analyzeDurationMs** | **Integer** | | [optional] | |**defaultAudioStreamIndex** | **Integer** | | [optional] | |**defaultSubtitleStreamIndex** | **Integer** | | [optional] | +|**hasSegments** | **Boolean** | | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MediaSourceType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSourceType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MediaSourceType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaSourceType.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/MediaStream.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaStream.md similarity index 85% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/MediaStream.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaStream.md index 93cb1c59207ee..0c341942e211d 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/MediaStream.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaStream.md @@ -23,17 +23,20 @@ Class MediaStream. |**elPresentFlag** | **Integer** | Gets or sets the Dolby Vision el present flag. | [optional] | |**blPresentFlag** | **Integer** | Gets or sets the Dolby Vision bl present flag. | [optional] | |**dvBlSignalCompatibilityId** | **Integer** | Gets or sets the Dolby Vision bl signal compatibility id. | [optional] | +|**rotation** | **Integer** | Gets or sets the Rotation in degrees. | [optional] | |**comment** | **String** | Gets or sets the comment. | [optional] | |**timeBase** | **String** | Gets or sets the time base. | [optional] | |**codecTimeBase** | **String** | Gets or sets the codec time base. | [optional] | |**title** | **String** | Gets or sets the title. | [optional] | -|**videoRange** | **String** | Gets the video range. | [optional] [readonly] | -|**videoRangeType** | **String** | Gets the video range type. | [optional] [readonly] | +|**videoRange** | **VideoRange** | An enum representing video ranges. | [optional] [readonly] | +|**videoRangeType** | **VideoRangeType** | An enum representing types of video ranges. | [optional] [readonly] | |**videoDoViTitle** | **String** | Gets the video dovi title. | [optional] [readonly] | +|**audioSpatialFormat** | **AudioSpatialFormat** | An enum representing formats of spatial audio. | [optional] [readonly] | |**localizedUndefined** | **String** | | [optional] | |**localizedDefault** | **String** | | [optional] | |**localizedForced** | **String** | | [optional] | |**localizedExternal** | **String** | | [optional] | +|**localizedHearingImpaired** | **String** | | [optional] | |**displayTitle** | **String** | | [optional] [readonly] | |**nalLengthSize** | **String** | | [optional] | |**isInterlaced** | **Boolean** | Gets or sets a value indicating whether this instance is interlaced. | [optional] | @@ -47,10 +50,12 @@ Class MediaStream. |**sampleRate** | **Integer** | Gets or sets the sample rate. | [optional] | |**isDefault** | **Boolean** | Gets or sets a value indicating whether this instance is default. | [optional] | |**isForced** | **Boolean** | Gets or sets a value indicating whether this instance is forced. | [optional] | +|**isHearingImpaired** | **Boolean** | Gets or sets a value indicating whether this instance is for the hearing impaired. | [optional] | |**height** | **Integer** | Gets or sets the height. | [optional] | |**width** | **Integer** | Gets or sets the width. | [optional] | |**averageFrameRate** | **Float** | Gets or sets the average frame rate. | [optional] | |**realFrameRate** | **Float** | Gets or sets the real frame rate. | [optional] | +|**referenceFrameRate** | **Float** | Gets the framerate used as reference. Prefer AverageFrameRate, if that is null or an unrealistic value then fallback to RealFrameRate. | [optional] [readonly] | |**profile** | **String** | Gets or sets the profile. | [optional] | |**type** | **MediaStreamType** | Gets or sets the type. | [optional] | |**aspectRatio** | **String** | Gets or sets the aspect ratio. | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaStreamProtocol.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaStreamProtocol.md new file mode 100644 index 0000000000000..cbd84b777249b --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaStreamProtocol.md @@ -0,0 +1,13 @@ + + +# MediaStreamProtocol + +## Enum + + +* `HTTP` (value: `"http"`) + +* `HLS` (value: `"hls"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/MediaStreamType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaStreamType.md similarity index 87% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/MediaStreamType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaStreamType.md index d16743d2ee173..2ca0ca0e6e16c 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/MediaStreamType.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaStreamType.md @@ -15,5 +15,7 @@ * `DATA` (value: `"Data"`) +* `LYRIC` (value: `"Lyric"`) + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaType.md new file mode 100644 index 0000000000000..d5e2f87a30bc6 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaType.md @@ -0,0 +1,19 @@ + + +# MediaType + +## Enum + + +* `UNKNOWN` (value: `"Unknown"`) + +* `VIDEO` (value: `"Video"`) + +* `AUDIO` (value: `"Audio"`) + +* `PHOTO` (value: `"Photo"`) + +* `BOOK` (value: `"Book"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MediaUpdateInfoDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaUpdateInfoDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MediaUpdateInfoDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaUpdateInfoDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MediaUpdateInfoPathDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaUpdateInfoPathDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MediaUpdateInfoPathDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaUpdateInfoPathDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MediaUrl.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaUrl.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MediaUrl.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MediaUrl.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MessageCommand.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MessageCommand.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MessageCommand.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MessageCommand.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MetadataConfiguration.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MetadataConfiguration.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MetadataConfiguration.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MetadataConfiguration.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/MetadataEditorInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MetadataEditorInfo.md similarity index 91% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/MetadataEditorInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MetadataEditorInfo.md index 895484c43f86d..9e64132debc48 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/MetadataEditorInfo.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MetadataEditorInfo.md @@ -11,7 +11,7 @@ |**countries** | [**List<CountryInfo>**](CountryInfo.md) | | [optional] | |**cultures** | [**List<CultureDto>**](CultureDto.md) | | [optional] | |**externalIdInfos** | [**List<ExternalIdInfo>**](ExternalIdInfo.md) | | [optional] | -|**contentType** | **String** | | [optional] | +|**contentType** | **CollectionType** | | [optional] | |**contentTypeOptions** | [**List<NameValuePair>**](NameValuePair.md) | | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MetadataField.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MetadataField.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MetadataField.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MetadataField.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MetadataOptions.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MetadataOptions.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MetadataOptions.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MetadataOptions.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MetadataRefreshMode.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MetadataRefreshMode.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MetadataRefreshMode.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MetadataRefreshMode.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MovePlaylistItemRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MovePlaylistItemRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MovePlaylistItemRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MovePlaylistItemRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MovieInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MovieInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MovieInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MovieInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MovieInfoRemoteSearchQuery.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MovieInfoRemoteSearchQuery.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MovieInfoRemoteSearchQuery.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MovieInfoRemoteSearchQuery.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MoviesApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MoviesApi.md new file mode 100644 index 0000000000000..b30a6c4a4ca82 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MoviesApi.md @@ -0,0 +1,86 @@ +# MoviesApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getMovieRecommendations**](MoviesApi.md#getMovieRecommendations) | **GET** /Movies/Recommendations | Gets movie recommendations. | + + + +# **getMovieRecommendations** +> List<RecommendationDto> getMovieRecommendations(userId, parentId, fields, categoryLimit, itemLimit) + +Gets movie recommendations. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.MoviesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + MoviesApi apiInstance = new MoviesApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + UUID parentId = UUID.randomUUID(); // UUID | Specify this to localize the search to a specific item or folder. Omit to use the root. + List fields = Arrays.asList(); // List | Optional. The fields to return. + Integer categoryLimit = 5; // Integer | The max number of categories to return. + Integer itemLimit = 8; // Integer | The max number of items to return per category. + try { + List result = apiInstance.getMovieRecommendations(userId, parentId, fields, categoryLimit, itemLimit); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling MoviesApi#getMovieRecommendations"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | +| **parentId** | **UUID**| Specify this to localize the search to a specific item or folder. Omit to use the root. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. The fields to return. | [optional] | +| **categoryLimit** | **Integer**| The max number of categories to return. | [optional] [default to 5] | +| **itemLimit** | **Integer**| The max number of items to return per category. | [optional] [default to 8] | + +### Return type + +[**List<RecommendationDto>**](RecommendationDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Movie recommendations returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MusicGenresApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MusicGenresApi.md new file mode 100644 index 0000000000000..6405de6880c8e --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MusicGenresApi.md @@ -0,0 +1,184 @@ +# MusicGenresApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getMusicGenre**](MusicGenresApi.md#getMusicGenre) | **GET** /MusicGenres/{genreName} | Gets a music genre, by name. | +| [**getMusicGenres**](MusicGenresApi.md#getMusicGenres) | **GET** /MusicGenres | Gets all music genres from a given item, folder, or the entire library. | + + + +# **getMusicGenre** +> BaseItemDto getMusicGenre(genreName, userId) + +Gets a music genre, by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.MusicGenresApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + MusicGenresApi apiInstance = new MusicGenresApi(defaultClient); + String genreName = "genreName_example"; // String | The genre name. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + try { + BaseItemDto result = apiInstance.getMusicGenre(genreName, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling MusicGenresApi#getMusicGenre"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **genreName** | **String**| The genre name. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | + +### Return type + +[**BaseItemDto**](BaseItemDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getMusicGenres** +> BaseItemDtoQueryResult getMusicGenres(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount) + +Gets all music genres from a given item, folder, or the entire library. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.MusicGenresApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + MusicGenresApi apiInstance = new MusicGenresApi(defaultClient); + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + String searchTerm = "searchTerm_example"; // String | The search term. + UUID parentId = UUID.randomUUID(); // UUID | Specify this to localize the search to a specific item or folder. Omit to use the root. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + List excludeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. + List includeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered in based on item type. This allows multiple, comma delimited. + Boolean isFavorite = true; // Boolean | Optional filter by items that are marked as favorite, or not. + Integer imageTypeLimit = 56; // Integer | Optional, the max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + UUID userId = UUID.randomUUID(); // UUID | User id. + String nameStartsWithOrGreater = "nameStartsWithOrGreater_example"; // String | Optional filter by items whose name is sorted equally or greater than a given input string. + String nameStartsWith = "nameStartsWith_example"; // String | Optional filter by items whose name is sorted equally than a given input string. + String nameLessThan = "nameLessThan_example"; // String | Optional filter by items whose name is equally or lesser than a given input string. + List sortBy = Arrays.asList(); // List | Optional. Specify one or more sort orders, comma delimited. + List sortOrder = Arrays.asList(); // List | Sort Order - Ascending,Descending. + Boolean enableImages = true; // Boolean | Optional, include image information in output. + Boolean enableTotalRecordCount = true; // Boolean | Optional. Include total record count. + try { + BaseItemDtoQueryResult result = apiInstance.getMusicGenres(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling MusicGenresApi#getMusicGenres"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **searchTerm** | **String**| The search term. | [optional] | +| **parentId** | **UUID**| Specify this to localize the search to a specific item or folder. Omit to use the root. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **excludeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. | [optional] | +| **includeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered in based on item type. This allows multiple, comma delimited. | [optional] | +| **isFavorite** | **Boolean**| Optional filter by items that are marked as favorite, or not. | [optional] | +| **imageTypeLimit** | **Integer**| Optional, the max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **userId** | **UUID**| 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] | +| **sortBy** | [**List<ItemSortBy>**](ItemSortBy.md)| Optional. Specify one or more sort orders, comma delimited. | [optional] | +| **sortOrder** | [**List<SortOrder>**](SortOrder.md)| Sort Order - Ascending,Descending. | [optional] | +| **enableImages** | **Boolean**| Optional, include image information in output. | [optional] [default to true] | +| **enableTotalRecordCount** | **Boolean**| Optional. Include total record count. | [optional] [default to true] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Music genres returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MusicVideoInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MusicVideoInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MusicVideoInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MusicVideoInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MusicVideoInfoRemoteSearchQuery.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MusicVideoInfoRemoteSearchQuery.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/MusicVideoInfoRemoteSearchQuery.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/MusicVideoInfoRemoteSearchQuery.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/NameGuidPair.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/NameGuidPair.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/NameGuidPair.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/NameGuidPair.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/NameIdPair.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/NameIdPair.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/NameIdPair.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/NameIdPair.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/NameValuePair.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/NameValuePair.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/NameValuePair.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/NameValuePair.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/NetworkConfiguration.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/NetworkConfiguration.md new file mode 100644 index 0000000000000..18f9c6a84bbd6 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/NetworkConfiguration.md @@ -0,0 +1,36 @@ + + +# NetworkConfiguration + +Defines the MediaBrowser.Common.Net.NetworkConfiguration. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**baseUrl** | **String** | Gets or sets a value used to specify the URL prefix that your Jellyfin instance can be accessed at. | [optional] | +|**enableHttps** | **Boolean** | Gets or sets a value indicating whether to use HTTPS. | [optional] | +|**requireHttps** | **Boolean** | Gets or sets a value indicating whether the server should force connections over HTTPS. | [optional] | +|**certificatePath** | **String** | Gets or sets the filesystem path of an X.509 certificate to use for SSL. | [optional] | +|**certificatePassword** | **String** | Gets or sets the password required to access the X.509 certificate data in the file specified by MediaBrowser.Common.Net.NetworkConfiguration.CertificatePath. | [optional] | +|**internalHttpPort** | **Integer** | Gets or sets the internal HTTP server port. | [optional] | +|**internalHttpsPort** | **Integer** | Gets or sets the internal HTTPS server port. | [optional] | +|**publicHttpPort** | **Integer** | Gets or sets the public HTTP port. | [optional] | +|**publicHttpsPort** | **Integer** | Gets or sets the public HTTPS port. | [optional] | +|**autoDiscovery** | **Boolean** | Gets or sets a value indicating whether Autodiscovery is enabled. | [optional] | +|**enableUPnP** | **Boolean** | Gets or sets a value indicating whether to enable automatic port forwarding. | [optional] | +|**enableIPv4** | **Boolean** | Gets or sets a value indicating whether IPv6 is enabled. | [optional] | +|**enableIPv6** | **Boolean** | Gets or sets a value indicating whether IPv6 is enabled. | [optional] | +|**enableRemoteAccess** | **Boolean** | Gets or sets a value indicating whether access from outside of the LAN is permitted. | [optional] | +|**localNetworkSubnets** | **List<String>** | Gets or sets the subnets that are deemed to make up the LAN. | [optional] | +|**localNetworkAddresses** | **List<String>** | Gets or sets the interface addresses which Jellyfin will bind to. If empty, all interfaces will be used. | [optional] | +|**knownProxies** | **List<String>** | Gets or sets the known proxies. | [optional] | +|**ignoreVirtualInterfaces** | **Boolean** | Gets or sets a value indicating whether address names that match MediaBrowser.Common.Net.NetworkConfiguration.VirtualInterfaceNames should be ignored for the purposes of binding. | [optional] | +|**virtualInterfaceNames** | **List<String>** | Gets or sets a value indicating the interface name prefixes that should be ignored. The list can be comma separated and values are case-insensitive. <seealso cref=\"P:MediaBrowser.Common.Net.NetworkConfiguration.IgnoreVirtualInterfaces\" />. | [optional] | +|**enablePublishedServerUriByRequest** | **Boolean** | Gets or sets a value indicating whether the published server uri is based on information in HTTP requests. | [optional] | +|**publishedServerUriBySubnet** | **List<String>** | Gets or sets the PublishedServerUriBySubnet Gets or sets PublishedServerUri to advertise for specific subnets. | [optional] | +|**remoteIPFilter** | **List<String>** | Gets or sets the filter for remote IP connectivity. Used in conjunction with <seealso cref=\"P:MediaBrowser.Common.Net.NetworkConfiguration.IsRemoteIPFilterBlacklist\" />. | [optional] | +|**isRemoteIPFilterBlacklist** | **Boolean** | Gets or sets a value indicating whether <seealso cref=\"P:MediaBrowser.Common.Net.NetworkConfiguration.RemoteIPFilter\" /> contains a blacklist or a whitelist. Default is a whitelist. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/NewGroupRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/NewGroupRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/NewGroupRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/NewGroupRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/NextItemRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/NextItemRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/NextItemRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/NextItemRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/OpenLiveStreamDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/OpenLiveStreamDto.md new file mode 100644 index 0000000000000..e099f166edf71 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/OpenLiveStreamDto.md @@ -0,0 +1,27 @@ + + +# OpenLiveStreamDto + +Open live stream dto. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**openToken** | **String** | Gets or sets the open token. | [optional] | +|**userId** | **UUID** | Gets or sets the user id. | [optional] | +|**playSessionId** | **String** | Gets or sets the play session id. | [optional] | +|**maxStreamingBitrate** | **Integer** | Gets or sets the max streaming bitrate. | [optional] | +|**startTimeTicks** | **Long** | Gets or sets the start time in ticks. | [optional] | +|**audioStreamIndex** | **Integer** | Gets or sets the audio stream index. | [optional] | +|**subtitleStreamIndex** | **Integer** | Gets or sets the subtitle stream index. | [optional] | +|**maxAudioChannels** | **Integer** | Gets or sets the max audio channels. | [optional] | +|**itemId** | **UUID** | Gets or sets the item id. | [optional] | +|**enableDirectPlay** | **Boolean** | Gets or sets a value indicating whether to enable direct play. | [optional] | +|**enableDirectStream** | **Boolean** | Gets or sets a value indicating whether to enale direct stream. | [optional] | +|**alwaysBurnInSubtitleWhenTranscoding** | **Boolean** | Gets or sets a value indicating whether always burn in subtitles when transcoding. | [optional] | +|**deviceProfile** | [**DeviceProfile**](DeviceProfile.md) | Gets or sets the device profile. | [optional] | +|**directPlayProtocols** | **List<MediaProtocol>** | Gets or sets the device play protocols. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/OutboundKeepAliveMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/OutboundKeepAliveMessage.md new file mode 100644 index 0000000000000..51779bc4390fc --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/OutboundKeepAliveMessage.md @@ -0,0 +1,15 @@ + + +# OutboundKeepAliveMessage + +Keep alive websocket messages. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/OutboundWebSocketMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/OutboundWebSocketMessage.md new file mode 100644 index 0000000000000..f838ebe2d1cba --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/OutboundWebSocketMessage.md @@ -0,0 +1,16 @@ + + +# OutboundWebSocketMessage + +Represents the list of possible outbound websocket types + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**UserDto**](UserDto.md) | Class UserDto. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PackageApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PackageApi.md new file mode 100644 index 0000000000000..0de884e7b16a7 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PackageApi.md @@ -0,0 +1,426 @@ +# PackageApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**cancelPackageInstallation**](PackageApi.md#cancelPackageInstallation) | **DELETE** /Packages/Installing/{packageId} | Cancels a package installation. | +| [**getPackageInfo**](PackageApi.md#getPackageInfo) | **GET** /Packages/{name} | Gets a package by name or assembly GUID. | +| [**getPackages**](PackageApi.md#getPackages) | **GET** /Packages | Gets available packages. | +| [**getRepositories**](PackageApi.md#getRepositories) | **GET** /Repositories | Gets all package repositories. | +| [**installPackage**](PackageApi.md#installPackage) | **POST** /Packages/Installed/{name} | Installs a package. | +| [**setRepositories**](PackageApi.md#setRepositories) | **POST** /Repositories | Sets the enabled and existing package repositories. | + + + +# **cancelPackageInstallation** +> cancelPackageInstallation(packageId) + +Cancels a package installation. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PackageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PackageApi apiInstance = new PackageApi(defaultClient); + UUID packageId = UUID.randomUUID(); // UUID | Installation Id. + try { + apiInstance.cancelPackageInstallation(packageId); + } catch (ApiException e) { + System.err.println("Exception when calling PackageApi#cancelPackageInstallation"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **packageId** | **UUID**| Installation Id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Installation cancelled. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPackageInfo** +> PackageInfo getPackageInfo(name, assemblyGuid) + +Gets a package by name or assembly GUID. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PackageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PackageApi apiInstance = new PackageApi(defaultClient); + String name = "name_example"; // String | The name of the package. + UUID assemblyGuid = UUID.randomUUID(); // UUID | The GUID of the associated assembly. + try { + PackageInfo result = apiInstance.getPackageInfo(name, assemblyGuid); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PackageApi#getPackageInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| The name of the package. | | +| **assemblyGuid** | **UUID**| The GUID of the associated assembly. | [optional] | + +### Return type + +[**PackageInfo**](PackageInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Package retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPackages** +> List<PackageInfo> getPackages() + +Gets available packages. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PackageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PackageApi apiInstance = new PackageApi(defaultClient); + try { + List result = apiInstance.getPackages(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PackageApi#getPackages"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<PackageInfo>**](PackageInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Available packages returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getRepositories** +> List<RepositoryInfo> getRepositories() + +Gets all package repositories. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PackageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PackageApi apiInstance = new PackageApi(defaultClient); + try { + List result = apiInstance.getRepositories(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PackageApi#getRepositories"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<RepositoryInfo>**](RepositoryInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Package repositories returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **installPackage** +> installPackage(name, assemblyGuid, version, repositoryUrl) + +Installs a package. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PackageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PackageApi apiInstance = new PackageApi(defaultClient); + String name = "name_example"; // String | Package name. + UUID assemblyGuid = UUID.randomUUID(); // UUID | GUID of the associated assembly. + String version = "version_example"; // String | Optional version. Defaults to latest version. + String repositoryUrl = "repositoryUrl_example"; // String | Optional. Specify the repository to install from. + try { + apiInstance.installPackage(name, assemblyGuid, version, repositoryUrl); + } catch (ApiException e) { + System.err.println("Exception when calling PackageApi#installPackage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Package name. | | +| **assemblyGuid** | **UUID**| GUID of the associated assembly. | [optional] | +| **version** | **String**| Optional version. Defaults to latest version. | [optional] | +| **repositoryUrl** | **String**| Optional. Specify the repository to install from. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Package found. | - | +| **404** | Package not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **setRepositories** +> setRepositories(repositoryInfo) + +Sets the enabled and existing package repositories. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PackageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PackageApi apiInstance = new PackageApi(defaultClient); + List repositoryInfo = Arrays.asList(); // List | The list of package repositories. + try { + apiInstance.setRepositories(repositoryInfo); + } catch (ApiException e) { + System.err.println("Exception when calling PackageApi#setRepositories"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **repositoryInfo** | [**List<RepositoryInfo>**](RepositoryInfo.md)| The list of package repositories. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Package repositories saved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PackageInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PackageInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PackageInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PackageInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ParentalRating.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ParentalRating.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ParentalRating.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ParentalRating.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PathSubstitution.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PathSubstitution.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PathSubstitution.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PathSubstitution.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PersonKind.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PersonKind.md new file mode 100644 index 0000000000000..2dd6148486e89 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PersonKind.md @@ -0,0 +1,59 @@ + + +# PersonKind + +## Enum + + +* `UNKNOWN` (value: `"Unknown"`) + +* `ACTOR` (value: `"Actor"`) + +* `DIRECTOR` (value: `"Director"`) + +* `COMPOSER` (value: `"Composer"`) + +* `WRITER` (value: `"Writer"`) + +* `GUEST_STAR` (value: `"GuestStar"`) + +* `PRODUCER` (value: `"Producer"`) + +* `CONDUCTOR` (value: `"Conductor"`) + +* `LYRICIST` (value: `"Lyricist"`) + +* `ARRANGER` (value: `"Arranger"`) + +* `ENGINEER` (value: `"Engineer"`) + +* `MIXER` (value: `"Mixer"`) + +* `REMIXER` (value: `"Remixer"`) + +* `CREATOR` (value: `"Creator"`) + +* `ARTIST` (value: `"Artist"`) + +* `ALBUM_ARTIST` (value: `"AlbumArtist"`) + +* `AUTHOR` (value: `"Author"`) + +* `ILLUSTRATOR` (value: `"Illustrator"`) + +* `PENCILLER` (value: `"Penciller"`) + +* `INKER` (value: `"Inker"`) + +* `COLORIST` (value: `"Colorist"`) + +* `LETTERER` (value: `"Letterer"`) + +* `COVER_ARTIST` (value: `"CoverArtist"`) + +* `EDITOR` (value: `"Editor"`) + +* `TRANSLATOR` (value: `"Translator"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PersonLookupInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PersonLookupInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PersonLookupInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PersonLookupInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PersonLookupInfoRemoteSearchQuery.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PersonLookupInfoRemoteSearchQuery.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PersonLookupInfoRemoteSearchQuery.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PersonLookupInfoRemoteSearchQuery.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PersonsApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PersonsApi.md new file mode 100644 index 0000000000000..00502c58cc518 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PersonsApi.md @@ -0,0 +1,175 @@ +# PersonsApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getPerson**](PersonsApi.md#getPerson) | **GET** /Persons/{name} | Get person by name. | +| [**getPersons**](PersonsApi.md#getPersons) | **GET** /Persons | Gets all persons. | + + + +# **getPerson** +> BaseItemDto getPerson(name, userId) + +Get person by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PersonsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PersonsApi apiInstance = new PersonsApi(defaultClient); + String name = "name_example"; // String | Person name. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + try { + BaseItemDto result = apiInstance.getPerson(name, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PersonsApi#getPerson"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Person name. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | + +### Return type + +[**BaseItemDto**](BaseItemDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Person returned. | - | +| **404** | Person not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPersons** +> BaseItemDtoQueryResult getPersons(limit, searchTerm, fields, filters, isFavorite, enableUserData, imageTypeLimit, enableImageTypes, excludePersonTypes, personTypes, appearsInItemId, userId, enableImages) + +Gets all persons. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PersonsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PersonsApi apiInstance = new PersonsApi(defaultClient); + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + String searchTerm = "searchTerm_example"; // String | The search term. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + List filters = Arrays.asList(); // List | Optional. Specify additional filters to apply. + Boolean isFavorite = true; // Boolean | Optional filter by items that are marked as favorite, or not. userId is required. + Boolean enableUserData = true; // Boolean | Optional, include user data. + Integer imageTypeLimit = 56; // Integer | Optional, the max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + List excludePersonTypes = Arrays.asList(); // List | Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited. + List personTypes = Arrays.asList(); // List | Optional. If specified results will be filtered to include only those containing the specified PersonType. Allows multiple, comma-delimited. + UUID appearsInItemId = UUID.randomUUID(); // UUID | Optional. If specified, person results will be filtered on items related to said persons. + UUID userId = UUID.randomUUID(); // UUID | User id. + Boolean enableImages = true; // Boolean | Optional, include image information in output. + try { + BaseItemDtoQueryResult result = apiInstance.getPersons(limit, searchTerm, fields, filters, isFavorite, enableUserData, imageTypeLimit, enableImageTypes, excludePersonTypes, personTypes, appearsInItemId, userId, enableImages); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PersonsApi#getPersons"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **searchTerm** | **String**| The search term. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **filters** | [**List<ItemFilter>**](ItemFilter.md)| Optional. Specify additional filters to apply. | [optional] | +| **isFavorite** | **Boolean**| Optional filter by items that are marked as favorite, or not. userId is required. | [optional] | +| **enableUserData** | **Boolean**| Optional, include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional, the max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **excludePersonTypes** | [**List<String>**](String.md)| Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited. | [optional] | +| **personTypes** | [**List<String>**](String.md)| Optional. If specified results will be filtered to include only those containing the specified PersonType. Allows multiple, comma-delimited. | [optional] | +| **appearsInItemId** | **UUID**| Optional. If specified, person results will be filtered on items related to said persons. | [optional] | +| **userId** | **UUID**| User id. | [optional] | +| **enableImages** | **Boolean**| Optional, include image information in output. | [optional] [default to true] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Persons returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PinRedeemResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PinRedeemResult.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PinRedeemResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PinRedeemResult.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PingRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PingRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PingRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PingRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlayAccess.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayAccess.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlayAccess.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayAccess.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlayCommand.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayCommand.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlayCommand.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayCommand.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayMessage.md new file mode 100644 index 0000000000000..e10d1ee91c053 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayMessage.md @@ -0,0 +1,16 @@ + + +# PlayMessage + +Play command websocket message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**PlayRequest**](PlayRequest.md) | Class PlayRequest. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlayMethod.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayMethod.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlayMethod.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayMethod.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayQueueUpdate.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayQueueUpdate.md new file mode 100644 index 0000000000000..46e7262f5200c --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayQueueUpdate.md @@ -0,0 +1,21 @@ + + +# PlayQueueUpdate + +Class PlayQueueUpdate. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**reason** | **PlayQueueUpdateReason** | Gets the request type that originated this update. | [optional] | +|**lastUpdate** | **OffsetDateTime** | Gets the UTC time of the last change to the playing queue. | [optional] | +|**playlist** | [**List<SyncPlayQueueItem>**](SyncPlayQueueItem.md) | Gets the playlist. | [optional] | +|**playingItemIndex** | **Integer** | Gets the playing item index in the playlist. | [optional] | +|**startPositionTicks** | **Long** | Gets the start position ticks. | [optional] | +|**isPlaying** | **Boolean** | Gets a value indicating whether the current item is playing. | [optional] | +|**shuffleMode** | **GroupShuffleMode** | Gets the shuffle mode. | [optional] | +|**repeatMode** | **GroupRepeatMode** | Gets the repeat mode. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayQueueUpdateGroupUpdate.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayQueueUpdateGroupUpdate.md new file mode 100644 index 0000000000000..4041676645bdb --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayQueueUpdateGroupUpdate.md @@ -0,0 +1,16 @@ + + +# PlayQueueUpdateGroupUpdate + +Class GroupUpdate. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**groupId** | **UUID** | Gets the group identifier. | [optional] [readonly] | +|**type** | **GroupUpdateType** | Gets the update type. | [optional] | +|**data** | [**PlayQueueUpdate**](PlayQueueUpdate.md) | Gets the update data. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayQueueUpdateReason.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayQueueUpdateReason.md new file mode 100644 index 0000000000000..b3c1332e5c98b --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayQueueUpdateReason.md @@ -0,0 +1,29 @@ + + +# PlayQueueUpdateReason + +## Enum + + +* `NEW_PLAYLIST` (value: `"NewPlaylist"`) + +* `SET_CURRENT_ITEM` (value: `"SetCurrentItem"`) + +* `REMOVE_ITEMS` (value: `"RemoveItems"`) + +* `MOVE_ITEM` (value: `"MoveItem"`) + +* `QUEUE` (value: `"Queue"`) + +* `QUEUE_NEXT` (value: `"QueueNext"`) + +* `NEXT_ITEM` (value: `"NextItem"`) + +* `PREVIOUS_ITEM` (value: `"PreviousItem"`) + +* `REPEAT_MODE` (value: `"RepeatMode"`) + +* `SHUFFLE_MODE` (value: `"ShuffleMode"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlayRequest.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayRequest.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlayRequest.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayRequest.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlayRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlayRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlaybackErrorCode.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackErrorCode.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlaybackErrorCode.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackErrorCode.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackInfoDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackInfoDto.md new file mode 100644 index 0000000000000..628f60f4a1fa1 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackInfoDto.md @@ -0,0 +1,29 @@ + + +# PlaybackInfoDto + +Plabyback info dto. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**userId** | **UUID** | Gets or sets the playback userId. | [optional] | +|**maxStreamingBitrate** | **Integer** | Gets or sets the max streaming bitrate. | [optional] | +|**startTimeTicks** | **Long** | Gets or sets the start time in ticks. | [optional] | +|**audioStreamIndex** | **Integer** | Gets or sets the audio stream index. | [optional] | +|**subtitleStreamIndex** | **Integer** | Gets or sets the subtitle stream index. | [optional] | +|**maxAudioChannels** | **Integer** | Gets or sets the max audio channels. | [optional] | +|**mediaSourceId** | **String** | Gets or sets the media source id. | [optional] | +|**liveStreamId** | **String** | Gets or sets the live stream id. | [optional] | +|**deviceProfile** | [**DeviceProfile**](DeviceProfile.md) | Gets or sets the device profile. | [optional] | +|**enableDirectPlay** | **Boolean** | Gets or sets a value indicating whether to enable direct play. | [optional] | +|**enableDirectStream** | **Boolean** | Gets or sets a value indicating whether to enable direct stream. | [optional] | +|**enableTranscoding** | **Boolean** | Gets or sets a value indicating whether to enable transcoding. | [optional] | +|**allowVideoStreamCopy** | **Boolean** | Gets or sets a value indicating whether to enable video stream copy. | [optional] | +|**allowAudioStreamCopy** | **Boolean** | Gets or sets a value indicating whether to allow audio stream copy. | [optional] | +|**autoOpenLiveStream** | **Boolean** | Gets or sets a value indicating whether to auto open the live stream. | [optional] | +|**alwaysBurnInSubtitleWhenTranscoding** | **Boolean** | Gets or sets a value indicating whether always burn in subtitles when transcoding. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlaybackInfoResponse.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackInfoResponse.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlaybackInfoResponse.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackInfoResponse.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackOrder.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackOrder.md new file mode 100644 index 0000000000000..4e4ac23ae1dd3 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackOrder.md @@ -0,0 +1,13 @@ + + +# PlaybackOrder + +## Enum + + +* `DEFAULT` (value: `"Default"`) + +* `SHUFFLE` (value: `"Shuffle"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/PlaybackProgressInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackProgressInfo.md similarity index 95% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/PlaybackProgressInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackProgressInfo.md index 7e9b4ad3259d0..a4e943ccf2a0c 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/PlaybackProgressInfo.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackProgressInfo.md @@ -26,6 +26,7 @@ Class PlaybackProgressInfo. |**liveStreamId** | **String** | Gets or sets the live stream identifier. | [optional] | |**playSessionId** | **String** | Gets or sets the play session identifier. | [optional] | |**repeatMode** | **RepeatMode** | Gets or sets the repeat mode. | [optional] | +|**playbackOrder** | **PlaybackOrder** | Gets or sets the playback order. | [optional] | |**nowPlayingQueue** | [**List<QueueItem>**](QueueItem.md) | | [optional] | |**playlistItemId** | **String** | | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackRequestType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackRequestType.md new file mode 100644 index 0000000000000..e36548dec91bb --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackRequestType.md @@ -0,0 +1,43 @@ + + +# PlaybackRequestType + +## Enum + + +* `PLAY` (value: `"Play"`) + +* `SET_PLAYLIST_ITEM` (value: `"SetPlaylistItem"`) + +* `REMOVE_FROM_PLAYLIST` (value: `"RemoveFromPlaylist"`) + +* `MOVE_PLAYLIST_ITEM` (value: `"MovePlaylistItem"`) + +* `QUEUE` (value: `"Queue"`) + +* `UNPAUSE` (value: `"Unpause"`) + +* `PAUSE` (value: `"Pause"`) + +* `STOP` (value: `"Stop"`) + +* `SEEK` (value: `"Seek"`) + +* `BUFFER` (value: `"Buffer"`) + +* `READY` (value: `"Ready"`) + +* `NEXT_ITEM` (value: `"NextItem"`) + +* `PREVIOUS_ITEM` (value: `"PreviousItem"`) + +* `SET_REPEAT_MODE` (value: `"SetRepeatMode"`) + +* `SET_SHUFFLE_MODE` (value: `"SetShuffleMode"`) + +* `PING` (value: `"Ping"`) + +* `IGNORE_WAIT` (value: `"IgnoreWait"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/PlaybackStartInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackStartInfo.md similarity index 95% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/PlaybackStartInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackStartInfo.md index 0d2fdcfc02268..62165a15f52b0 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/PlaybackStartInfo.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackStartInfo.md @@ -26,6 +26,7 @@ Class PlaybackStartInfo. |**liveStreamId** | **String** | Gets or sets the live stream identifier. | [optional] | |**playSessionId** | **String** | Gets or sets the play session identifier. | [optional] | |**repeatMode** | **RepeatMode** | Gets or sets the repeat mode. | [optional] | +|**playbackOrder** | **PlaybackOrder** | Gets or sets the playback order. | [optional] | |**nowPlayingQueue** | [**List<QueueItem>**](QueueItem.md) | | [optional] | |**playlistItemId** | **String** | | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlaybackStopInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackStopInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlaybackStopInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaybackStopInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/PlayerStateInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayerStateInfo.md similarity index 93% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/PlayerStateInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayerStateInfo.md index 44fd582ce9c50..f4c01671aeb7e 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/PlayerStateInfo.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlayerStateInfo.md @@ -17,6 +17,7 @@ |**mediaSourceId** | **String** | Gets or sets the now playing media version identifier. | [optional] | |**playMethod** | **PlayMethod** | Gets or sets the play method. | [optional] | |**repeatMode** | **RepeatMode** | Gets or sets the repeat mode. | [optional] | +|**playbackOrder** | **PlaybackOrder** | Gets or sets the playback order. | [optional] | |**liveStreamId** | **String** | Gets or sets the now playing live stream identifier. | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlaylistCreationResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaylistCreationResult.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlaylistCreationResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaylistCreationResult.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaylistDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaylistDto.md new file mode 100644 index 0000000000000..60d25bba4d3b8 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaylistDto.md @@ -0,0 +1,16 @@ + + +# PlaylistDto + +DTO for playlists. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**openAccess** | **Boolean** | Gets or sets a value indicating whether the playlist is publicly readable. | [optional] | +|**shares** | [**List<PlaylistUserPermissions>**](PlaylistUserPermissions.md) | Gets or sets the share permissions. | [optional] | +|**itemIds** | **List<UUID>** | Gets or sets the item ids. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaylistUserPermissions.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaylistUserPermissions.md new file mode 100644 index 0000000000000..07e2969753ad9 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaylistUserPermissions.md @@ -0,0 +1,15 @@ + + +# PlaylistUserPermissions + +Class to hold data on user permissions for playlists. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**userId** | **UUID** | Gets or sets the user id. | [optional] | +|**canEdit** | **Boolean** | Gets or sets a value indicating whether the user has edit permissions. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaylistsApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaylistsApi.md new file mode 100644 index 0000000000000..d98d02f8dfe50 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaylistsApi.md @@ -0,0 +1,828 @@ +# PlaylistsApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**addItemToPlaylist**](PlaylistsApi.md#addItemToPlaylist) | **POST** /Playlists/{playlistId}/Items | Adds items to a playlist. | +| [**createPlaylist**](PlaylistsApi.md#createPlaylist) | **POST** /Playlists | Creates a new playlist. | +| [**getPlaylist**](PlaylistsApi.md#getPlaylist) | **GET** /Playlists/{playlistId} | Get a playlist. | +| [**getPlaylistItems**](PlaylistsApi.md#getPlaylistItems) | **GET** /Playlists/{playlistId}/Items | Gets the original items of a playlist. | +| [**getPlaylistUser**](PlaylistsApi.md#getPlaylistUser) | **GET** /Playlists/{playlistId}/Users/{userId} | Get a playlist user. | +| [**getPlaylistUsers**](PlaylistsApi.md#getPlaylistUsers) | **GET** /Playlists/{playlistId}/Users | Get a playlist's users. | +| [**moveItem**](PlaylistsApi.md#moveItem) | **POST** /Playlists/{playlistId}/Items/{itemId}/Move/{newIndex} | Moves a playlist item. | +| [**removeItemFromPlaylist**](PlaylistsApi.md#removeItemFromPlaylist) | **DELETE** /Playlists/{playlistId}/Items | Removes items from a playlist. | +| [**removeUserFromPlaylist**](PlaylistsApi.md#removeUserFromPlaylist) | **DELETE** /Playlists/{playlistId}/Users/{userId} | Remove a user from a playlist's users. | +| [**updatePlaylist**](PlaylistsApi.md#updatePlaylist) | **POST** /Playlists/{playlistId} | Updates a playlist. | +| [**updatePlaylistUser**](PlaylistsApi.md#updatePlaylistUser) | **POST** /Playlists/{playlistId}/Users/{userId} | Modify a user of a playlist's users. | + + + +# **addItemToPlaylist** +> addItemToPlaylist(playlistId, ids, userId) + +Adds items to a playlist. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaylistsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaylistsApi apiInstance = new PlaylistsApi(defaultClient); + UUID playlistId = UUID.randomUUID(); // UUID | The playlist id. + List ids = Arrays.asList(); // List | Item id, comma delimited. + UUID userId = UUID.randomUUID(); // UUID | The userId. + try { + apiInstance.addItemToPlaylist(playlistId, ids, userId); + } catch (ApiException e) { + System.err.println("Exception when calling PlaylistsApi#addItemToPlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **playlistId** | **UUID**| The playlist id. | | +| **ids** | [**List<UUID>**](UUID.md)| Item id, comma delimited. | [optional] | +| **userId** | **UUID**| The userId. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Items added to playlist. | - | +| **403** | Access forbidden. | - | +| **404** | Playlist not found. | - | +| **401** | Unauthorized | - | + + +# **createPlaylist** +> PlaylistCreationResult createPlaylist(name, ids, userId, mediaType, createPlaylistDto) + +Creates a new playlist. + +For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaylistsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaylistsApi apiInstance = new PlaylistsApi(defaultClient); + String name = "name_example"; // String | The playlist name. + List ids = Arrays.asList(); // List | The item ids. + UUID userId = UUID.randomUUID(); // UUID | The user id. + MediaType mediaType = MediaType.fromValue("Unknown"); // MediaType | The media type. + CreatePlaylistDto createPlaylistDto = new CreatePlaylistDto(); // CreatePlaylistDto | The create playlist payload. + try { + PlaylistCreationResult result = apiInstance.createPlaylist(name, ids, userId, mediaType, createPlaylistDto); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PlaylistsApi#createPlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| The playlist name. | [optional] | +| **ids** | [**List<UUID>**](UUID.md)| The item ids. | [optional] | +| **userId** | **UUID**| The user id. | [optional] | +| **mediaType** | **MediaType**| The media type. | [optional] [enum: Unknown, Video, Audio, Photo, Book] | +| **createPlaylistDto** | [**CreatePlaylistDto**](CreatePlaylistDto.md)| The create playlist payload. | [optional] | + +### Return type + +[**PlaylistCreationResult**](PlaylistCreationResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Playlist created. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPlaylist** +> PlaylistDto getPlaylist(playlistId) + +Get a playlist. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaylistsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaylistsApi apiInstance = new PlaylistsApi(defaultClient); + UUID playlistId = UUID.randomUUID(); // UUID | The playlist id. + try { + PlaylistDto result = apiInstance.getPlaylist(playlistId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PlaylistsApi#getPlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **playlistId** | **UUID**| The playlist id. | | + +### Return type + +[**PlaylistDto**](PlaylistDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | The playlist. | - | +| **404** | Playlist not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPlaylistItems** +> BaseItemDtoQueryResult getPlaylistItems(playlistId, userId, startIndex, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes) + +Gets the original items of a playlist. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaylistsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaylistsApi apiInstance = new PlaylistsApi(defaultClient); + UUID playlistId = UUID.randomUUID(); // UUID | The playlist id. + UUID userId = UUID.randomUUID(); // UUID | User id. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + try { + BaseItemDtoQueryResult result = apiInstance.getPlaylistItems(playlistId, userId, startIndex, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PlaylistsApi#getPlaylistItems"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **playlistId** | **UUID**| The playlist id. | | +| **userId** | **UUID**| User id. | [optional] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Original playlist returned. | - | +| **403** | Forbidden | - | +| **404** | Playlist not found. | - | +| **401** | Unauthorized | - | + + +# **getPlaylistUser** +> PlaylistUserPermissions getPlaylistUser(playlistId, userId) + +Get a playlist user. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaylistsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaylistsApi apiInstance = new PlaylistsApi(defaultClient); + UUID playlistId = UUID.randomUUID(); // UUID | The playlist id. + UUID userId = UUID.randomUUID(); // UUID | The user id. + try { + PlaylistUserPermissions result = apiInstance.getPlaylistUser(playlistId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PlaylistsApi#getPlaylistUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **playlistId** | **UUID**| The playlist id. | | +| **userId** | **UUID**| The user id. | | + +### Return type + +[**PlaylistUserPermissions**](PlaylistUserPermissions.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | User permission found. | - | +| **403** | Access forbidden. | - | +| **404** | Playlist not found. | - | +| **401** | Unauthorized | - | + + +# **getPlaylistUsers** +> List<PlaylistUserPermissions> getPlaylistUsers(playlistId) + +Get a playlist's users. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaylistsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaylistsApi apiInstance = new PlaylistsApi(defaultClient); + UUID playlistId = UUID.randomUUID(); // UUID | The playlist id. + try { + List result = apiInstance.getPlaylistUsers(playlistId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PlaylistsApi#getPlaylistUsers"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **playlistId** | **UUID**| The playlist id. | | + +### Return type + +[**List<PlaylistUserPermissions>**](PlaylistUserPermissions.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Found shares. | - | +| **403** | Access forbidden. | - | +| **404** | Playlist not found. | - | +| **401** | Unauthorized | - | + + +# **moveItem** +> moveItem(playlistId, itemId, newIndex) + +Moves a playlist item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaylistsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaylistsApi apiInstance = new PlaylistsApi(defaultClient); + String playlistId = "playlistId_example"; // String | The playlist id. + String itemId = "itemId_example"; // String | The item id. + Integer newIndex = 56; // Integer | The new index. + try { + apiInstance.moveItem(playlistId, itemId, newIndex); + } catch (ApiException e) { + System.err.println("Exception when calling PlaylistsApi#moveItem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **playlistId** | **String**| The playlist id. | | +| **itemId** | **String**| The item id. | | +| **newIndex** | **Integer**| The new index. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Item moved to new index. | - | +| **403** | Access forbidden. | - | +| **404** | Playlist not found. | - | +| **401** | Unauthorized | - | + + +# **removeItemFromPlaylist** +> removeItemFromPlaylist(playlistId, entryIds) + +Removes items from a playlist. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaylistsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaylistsApi apiInstance = new PlaylistsApi(defaultClient); + String playlistId = "playlistId_example"; // String | The playlist id. + List entryIds = Arrays.asList(); // List | The item ids, comma delimited. + try { + apiInstance.removeItemFromPlaylist(playlistId, entryIds); + } catch (ApiException e) { + System.err.println("Exception when calling PlaylistsApi#removeItemFromPlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **playlistId** | **String**| The playlist id. | | +| **entryIds** | [**List<String>**](String.md)| The item ids, comma delimited. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Items removed. | - | +| **403** | Access forbidden. | - | +| **404** | Playlist not found. | - | +| **401** | Unauthorized | - | + + +# **removeUserFromPlaylist** +> removeUserFromPlaylist(playlistId, userId) + +Remove a user from a playlist's users. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaylistsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaylistsApi apiInstance = new PlaylistsApi(defaultClient); + UUID playlistId = UUID.randomUUID(); // UUID | The playlist id. + UUID userId = UUID.randomUUID(); // UUID | The user id. + try { + apiInstance.removeUserFromPlaylist(playlistId, userId); + } catch (ApiException e) { + System.err.println("Exception when calling PlaylistsApi#removeUserFromPlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **playlistId** | **UUID**| The playlist id. | | +| **userId** | **UUID**| The user id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | User permissions removed from playlist. | - | +| **403** | Forbidden | - | +| **404** | No playlist or user permissions found. | - | +| **401** | Unauthorized access. | - | + + +# **updatePlaylist** +> updatePlaylist(playlistId, updatePlaylistDto) + +Updates a playlist. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaylistsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaylistsApi apiInstance = new PlaylistsApi(defaultClient); + UUID playlistId = UUID.randomUUID(); // UUID | The playlist id. + UpdatePlaylistDto updatePlaylistDto = new UpdatePlaylistDto(); // UpdatePlaylistDto | The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id. + try { + apiInstance.updatePlaylist(playlistId, updatePlaylistDto); + } catch (ApiException e) { + System.err.println("Exception when calling PlaylistsApi#updatePlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **playlistId** | **UUID**| The playlist id. | | +| **updatePlaylistDto** | [**UpdatePlaylistDto**](UpdatePlaylistDto.md)| The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Playlist updated. | - | +| **403** | Access forbidden. | - | +| **404** | Playlist not found. | - | +| **401** | Unauthorized | - | + + +# **updatePlaylistUser** +> updatePlaylistUser(playlistId, userId, updatePlaylistUserDto) + +Modify a user of a playlist's users. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaylistsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaylistsApi apiInstance = new PlaylistsApi(defaultClient); + UUID playlistId = UUID.randomUUID(); // UUID | The playlist id. + UUID userId = UUID.randomUUID(); // UUID | The user id. + UpdatePlaylistUserDto updatePlaylistUserDto = new UpdatePlaylistUserDto(); // UpdatePlaylistUserDto | The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto. + try { + apiInstance.updatePlaylistUser(playlistId, userId, updatePlaylistUserDto); + } catch (ApiException e) { + System.err.println("Exception when calling PlaylistsApi#updatePlaylistUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **playlistId** | **UUID**| The playlist id. | | +| **userId** | **UUID**| The user id. | | +| **updatePlaylistUserDto** | [**UpdatePlaylistUserDto**](UpdatePlaylistUserDto.md)| The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | User's permissions modified. | - | +| **403** | Access forbidden. | - | +| **404** | Playlist not found. | - | +| **401** | Unauthorized | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaystateApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaystateApi.md new file mode 100644 index 0000000000000..19b33c7753d7b --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaystateApi.md @@ -0,0 +1,685 @@ +# PlaystateApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**markPlayedItem**](PlaystateApi.md#markPlayedItem) | **POST** /UserPlayedItems/{itemId} | Marks an item as played for user. | +| [**markUnplayedItem**](PlaystateApi.md#markUnplayedItem) | **DELETE** /UserPlayedItems/{itemId} | Marks an item as unplayed for user. | +| [**onPlaybackProgress**](PlaystateApi.md#onPlaybackProgress) | **POST** /PlayingItems/{itemId}/Progress | Reports a session's playback progress. | +| [**onPlaybackStart**](PlaystateApi.md#onPlaybackStart) | **POST** /PlayingItems/{itemId} | Reports that a session has begun playing an item. | +| [**onPlaybackStopped**](PlaystateApi.md#onPlaybackStopped) | **DELETE** /PlayingItems/{itemId} | Reports that a session has stopped playing an item. | +| [**pingPlaybackSession**](PlaystateApi.md#pingPlaybackSession) | **POST** /Sessions/Playing/Ping | Pings a playback session. | +| [**reportPlaybackProgress**](PlaystateApi.md#reportPlaybackProgress) | **POST** /Sessions/Playing/Progress | Reports playback progress within a session. | +| [**reportPlaybackStart**](PlaystateApi.md#reportPlaybackStart) | **POST** /Sessions/Playing | Reports playback has started within a session. | +| [**reportPlaybackStopped**](PlaystateApi.md#reportPlaybackStopped) | **POST** /Sessions/Playing/Stopped | Reports playback has stopped within a session. | + + + +# **markPlayedItem** +> UserItemDataDto markPlayedItem(itemId, userId, datePlayed) + +Marks an item as played for user. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaystateApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaystateApi apiInstance = new PlaystateApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + UUID userId = UUID.randomUUID(); // UUID | User id. + OffsetDateTime datePlayed = OffsetDateTime.now(); // OffsetDateTime | Optional. The date the item was played. + try { + UserItemDataDto result = apiInstance.markPlayedItem(itemId, userId, datePlayed); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PlaystateApi#markPlayedItem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **userId** | **UUID**| User id. | [optional] | +| **datePlayed** | **OffsetDateTime**| Optional. The date the item was played. | [optional] | + +### Return type + +[**UserItemDataDto**](UserItemDataDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Item marked as played. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **markUnplayedItem** +> UserItemDataDto markUnplayedItem(itemId, userId) + +Marks an item as unplayed for user. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaystateApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaystateApi apiInstance = new PlaystateApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + UUID userId = UUID.randomUUID(); // UUID | User id. + try { + UserItemDataDto result = apiInstance.markUnplayedItem(itemId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PlaystateApi#markUnplayedItem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **userId** | **UUID**| User id. | [optional] | + +### Return type + +[**UserItemDataDto**](UserItemDataDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Item marked as unplayed. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **onPlaybackProgress** +> onPlaybackProgress(itemId, mediaSourceId, positionTicks, audioStreamIndex, subtitleStreamIndex, volumeLevel, playMethod, liveStreamId, playSessionId, repeatMode, isPaused, isMuted) + +Reports a session's playback progress. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaystateApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaystateApi apiInstance = new PlaystateApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + String mediaSourceId = "mediaSourceId_example"; // String | The id of the MediaSource. + Long positionTicks = 56L; // Long | Optional. The current position, in ticks. 1 tick = 10000 ms. + Integer audioStreamIndex = 56; // Integer | The audio stream index. + Integer subtitleStreamIndex = 56; // Integer | The subtitle stream index. + Integer volumeLevel = 56; // Integer | Scale of 0-100. + PlayMethod playMethod = PlayMethod.fromValue("Transcode"); // PlayMethod | The play method. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + String playSessionId = "playSessionId_example"; // String | The play session id. + RepeatMode repeatMode = RepeatMode.fromValue("RepeatNone"); // RepeatMode | The repeat mode. + Boolean isPaused = false; // Boolean | Indicates if the player is paused. + Boolean isMuted = false; // Boolean | Indicates if the player is muted. + try { + apiInstance.onPlaybackProgress(itemId, mediaSourceId, positionTicks, audioStreamIndex, subtitleStreamIndex, volumeLevel, playMethod, liveStreamId, playSessionId, repeatMode, isPaused, isMuted); + } catch (ApiException e) { + System.err.println("Exception when calling PlaystateApi#onPlaybackProgress"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **mediaSourceId** | **String**| The id of the MediaSource. | [optional] | +| **positionTicks** | **Long**| Optional. The current position, in ticks. 1 tick = 10000 ms. | [optional] | +| **audioStreamIndex** | **Integer**| The audio stream index. | [optional] | +| **subtitleStreamIndex** | **Integer**| The subtitle stream index. | [optional] | +| **volumeLevel** | **Integer**| Scale of 0-100. | [optional] | +| **playMethod** | **PlayMethod**| The play method. | [optional] [enum: Transcode, DirectStream, DirectPlay] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **repeatMode** | **RepeatMode**| The repeat mode. | [optional] [enum: RepeatNone, RepeatAll, RepeatOne] | +| **isPaused** | **Boolean**| Indicates if the player is paused. | [optional] [default to false] | +| **isMuted** | **Boolean**| Indicates if the player is muted. | [optional] [default to false] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Play progress recorded. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **onPlaybackStart** +> onPlaybackStart(itemId, mediaSourceId, audioStreamIndex, subtitleStreamIndex, playMethod, liveStreamId, playSessionId, canSeek) + +Reports that a session has begun playing an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaystateApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaystateApi apiInstance = new PlaystateApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + String mediaSourceId = "mediaSourceId_example"; // String | The id of the MediaSource. + Integer audioStreamIndex = 56; // Integer | The audio stream index. + Integer subtitleStreamIndex = 56; // Integer | The subtitle stream index. + PlayMethod playMethod = PlayMethod.fromValue("Transcode"); // PlayMethod | The play method. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + String playSessionId = "playSessionId_example"; // String | The play session id. + Boolean canSeek = false; // Boolean | Indicates if the client can seek. + try { + apiInstance.onPlaybackStart(itemId, mediaSourceId, audioStreamIndex, subtitleStreamIndex, playMethod, liveStreamId, playSessionId, canSeek); + } catch (ApiException e) { + System.err.println("Exception when calling PlaystateApi#onPlaybackStart"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **mediaSourceId** | **String**| The id of the MediaSource. | [optional] | +| **audioStreamIndex** | **Integer**| The audio stream index. | [optional] | +| **subtitleStreamIndex** | **Integer**| The subtitle stream index. | [optional] | +| **playMethod** | **PlayMethod**| The play method. | [optional] [enum: Transcode, DirectStream, DirectPlay] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **canSeek** | **Boolean**| Indicates if the client can seek. | [optional] [default to false] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Play start recorded. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **onPlaybackStopped** +> onPlaybackStopped(itemId, mediaSourceId, nextMediaType, positionTicks, liveStreamId, playSessionId) + +Reports that a session has stopped playing an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaystateApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaystateApi apiInstance = new PlaystateApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + String mediaSourceId = "mediaSourceId_example"; // String | The id of the MediaSource. + String nextMediaType = "nextMediaType_example"; // String | The next media type that will play. + Long positionTicks = 56L; // Long | Optional. The position, in ticks, where playback stopped. 1 tick = 10000 ms. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + String playSessionId = "playSessionId_example"; // String | The play session id. + try { + apiInstance.onPlaybackStopped(itemId, mediaSourceId, nextMediaType, positionTicks, liveStreamId, playSessionId); + } catch (ApiException e) { + System.err.println("Exception when calling PlaystateApi#onPlaybackStopped"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **mediaSourceId** | **String**| The id of the MediaSource. | [optional] | +| **nextMediaType** | **String**| The next media type that will play. | [optional] | +| **positionTicks** | **Long**| Optional. The position, in ticks, where playback stopped. 1 tick = 10000 ms. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Playback stop recorded. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **pingPlaybackSession** +> pingPlaybackSession(playSessionId) + +Pings a playback session. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaystateApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaystateApi apiInstance = new PlaystateApi(defaultClient); + String playSessionId = "playSessionId_example"; // String | Playback session id. + try { + apiInstance.pingPlaybackSession(playSessionId); + } catch (ApiException e) { + System.err.println("Exception when calling PlaystateApi#pingPlaybackSession"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **playSessionId** | **String**| Playback session id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Playback session pinged. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **reportPlaybackProgress** +> reportPlaybackProgress(playbackProgressInfo) + +Reports playback progress within a session. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaystateApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaystateApi apiInstance = new PlaystateApi(defaultClient); + PlaybackProgressInfo playbackProgressInfo = new PlaybackProgressInfo(); // PlaybackProgressInfo | The playback progress info. + try { + apiInstance.reportPlaybackProgress(playbackProgressInfo); + } catch (ApiException e) { + System.err.println("Exception when calling PlaystateApi#reportPlaybackProgress"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **playbackProgressInfo** | [**PlaybackProgressInfo**](PlaybackProgressInfo.md)| The playback progress info. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Playback progress recorded. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **reportPlaybackStart** +> reportPlaybackStart(playbackStartInfo) + +Reports playback has started within a session. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaystateApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaystateApi apiInstance = new PlaystateApi(defaultClient); + PlaybackStartInfo playbackStartInfo = new PlaybackStartInfo(); // PlaybackStartInfo | The playback start info. + try { + apiInstance.reportPlaybackStart(playbackStartInfo); + } catch (ApiException e) { + System.err.println("Exception when calling PlaystateApi#reportPlaybackStart"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **playbackStartInfo** | [**PlaybackStartInfo**](PlaybackStartInfo.md)| The playback start info. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Playback start recorded. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **reportPlaybackStopped** +> reportPlaybackStopped(playbackStopInfo) + +Reports playback has stopped within a session. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PlaystateApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PlaystateApi apiInstance = new PlaystateApi(defaultClient); + PlaybackStopInfo playbackStopInfo = new PlaybackStopInfo(); // PlaybackStopInfo | The playback stop info. + try { + apiInstance.reportPlaybackStopped(playbackStopInfo); + } catch (ApiException e) { + System.err.println("Exception when calling PlaystateApi#reportPlaybackStopped"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **playbackStopInfo** | [**PlaybackStopInfo**](PlaybackStopInfo.md)| The playback stop info. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Playback stop recorded. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlaystateCommand.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaystateCommand.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlaystateCommand.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaystateCommand.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaystateMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaystateMessage.md new file mode 100644 index 0000000000000..5b2ab380d14dc --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaystateMessage.md @@ -0,0 +1,16 @@ + + +# PlaystateMessage + +Playstate message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**PlaystateRequest**](PlaystateRequest.md) | Gets or sets the data. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlaystateRequest.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaystateRequest.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PlaystateRequest.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PlaystateRequest.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PluginInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PluginInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginInstallationCancelledMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginInstallationCancelledMessage.md new file mode 100644 index 0000000000000..6529f1f801f9f --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginInstallationCancelledMessage.md @@ -0,0 +1,16 @@ + + +# PluginInstallationCancelledMessage + +Plugin installation cancelled message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**InstallationInfo**](InstallationInfo.md) | Class InstallationInfo. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginInstallationCompletedMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginInstallationCompletedMessage.md new file mode 100644 index 0000000000000..3127280415fe5 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginInstallationCompletedMessage.md @@ -0,0 +1,16 @@ + + +# PluginInstallationCompletedMessage + +Plugin installation completed message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**InstallationInfo**](InstallationInfo.md) | Class InstallationInfo. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginInstallationFailedMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginInstallationFailedMessage.md new file mode 100644 index 0000000000000..46dbed5374955 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginInstallationFailedMessage.md @@ -0,0 +1,16 @@ + + +# PluginInstallationFailedMessage + +Plugin installation failed message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**InstallationInfo**](InstallationInfo.md) | Class InstallationInfo. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginInstallingMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginInstallingMessage.md new file mode 100644 index 0000000000000..a8e549464d8b9 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginInstallingMessage.md @@ -0,0 +1,16 @@ + + +# PluginInstallingMessage + +Package installing message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**InstallationInfo**](InstallationInfo.md) | Class InstallationInfo. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PluginStatus.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginStatus.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PluginStatus.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginStatus.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginUninstalledMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginUninstalledMessage.md new file mode 100644 index 0000000000000..aacc50c70b4c7 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginUninstalledMessage.md @@ -0,0 +1,16 @@ + + +# PluginUninstalledMessage + +Plugin uninstalled message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**PluginInfo**](PluginInfo.md) | This is a serializable stub class that is used by the api to provide information about installed plugins. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginsApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginsApi.md new file mode 100644 index 0000000000000..f231e4c47dad4 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PluginsApi.md @@ -0,0 +1,646 @@ +# PluginsApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**disablePlugin**](PluginsApi.md#disablePlugin) | **POST** /Plugins/{pluginId}/{version}/Disable | Disable a plugin. | +| [**enablePlugin**](PluginsApi.md#enablePlugin) | **POST** /Plugins/{pluginId}/{version}/Enable | Enables a disabled plugin. | +| [**getPluginConfiguration**](PluginsApi.md#getPluginConfiguration) | **GET** /Plugins/{pluginId}/Configuration | Gets plugin configuration. | +| [**getPluginImage**](PluginsApi.md#getPluginImage) | **GET** /Plugins/{pluginId}/{version}/Image | Gets a plugin's image. | +| [**getPluginManifest**](PluginsApi.md#getPluginManifest) | **POST** /Plugins/{pluginId}/Manifest | Gets a plugin's manifest. | +| [**getPlugins**](PluginsApi.md#getPlugins) | **GET** /Plugins | Gets a list of currently installed plugins. | +| [**uninstallPlugin**](PluginsApi.md#uninstallPlugin) | **DELETE** /Plugins/{pluginId} | Uninstalls a plugin. | +| [**uninstallPluginByVersion**](PluginsApi.md#uninstallPluginByVersion) | **DELETE** /Plugins/{pluginId}/{version} | Uninstalls a plugin by version. | +| [**updatePluginConfiguration**](PluginsApi.md#updatePluginConfiguration) | **POST** /Plugins/{pluginId}/Configuration | Updates plugin configuration. | + + + +# **disablePlugin** +> disablePlugin(pluginId, version) + +Disable a plugin. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PluginsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PluginsApi apiInstance = new PluginsApi(defaultClient); + UUID pluginId = UUID.randomUUID(); // UUID | Plugin id. + String version = "version_example"; // String | Plugin version. + try { + apiInstance.disablePlugin(pluginId, version); + } catch (ApiException e) { + System.err.println("Exception when calling PluginsApi#disablePlugin"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **pluginId** | **UUID**| Plugin id. | | +| **version** | **String**| Plugin version. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Plugin disabled. | - | +| **404** | Plugin not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **enablePlugin** +> enablePlugin(pluginId, version) + +Enables a disabled plugin. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PluginsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PluginsApi apiInstance = new PluginsApi(defaultClient); + UUID pluginId = UUID.randomUUID(); // UUID | Plugin id. + String version = "version_example"; // String | Plugin version. + try { + apiInstance.enablePlugin(pluginId, version); + } catch (ApiException e) { + System.err.println("Exception when calling PluginsApi#enablePlugin"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **pluginId** | **UUID**| Plugin id. | | +| **version** | **String**| Plugin version. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Plugin enabled. | - | +| **404** | Plugin not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPluginConfiguration** +> Object getPluginConfiguration(pluginId) + +Gets plugin configuration. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PluginsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PluginsApi apiInstance = new PluginsApi(defaultClient); + UUID pluginId = UUID.randomUUID(); // UUID | Plugin id. + try { + Object result = apiInstance.getPluginConfiguration(pluginId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PluginsApi#getPluginConfiguration"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **pluginId** | **UUID**| Plugin id. | | + +### Return type + +**Object** + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Plugin configuration returned. | - | +| **404** | Plugin not found or plugin configuration not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPluginImage** +> File getPluginImage(pluginId, version) + +Gets a plugin's image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PluginsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PluginsApi apiInstance = new PluginsApi(defaultClient); + UUID pluginId = UUID.randomUUID(); // UUID | Plugin id. + String version = "version_example"; // String | Plugin version. + try { + File result = apiInstance.getPluginImage(pluginId, version); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PluginsApi#getPluginImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **pluginId** | **UUID**| Plugin id. | | +| **version** | **String**| Plugin version. | | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Plugin image returned. | - | +| **404** | Not Found | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPluginManifest** +> getPluginManifest(pluginId) + +Gets a plugin's manifest. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PluginsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PluginsApi apiInstance = new PluginsApi(defaultClient); + UUID pluginId = UUID.randomUUID(); // UUID | Plugin id. + try { + apiInstance.getPluginManifest(pluginId); + } catch (ApiException e) { + System.err.println("Exception when calling PluginsApi#getPluginManifest"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **pluginId** | **UUID**| Plugin id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Plugin manifest returned. | - | +| **404** | Plugin not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPlugins** +> List<PluginInfo> getPlugins() + +Gets a list of currently installed plugins. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PluginsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PluginsApi apiInstance = new PluginsApi(defaultClient); + try { + List result = apiInstance.getPlugins(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PluginsApi#getPlugins"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<PluginInfo>**](PluginInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Installed plugins returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **uninstallPlugin** +> uninstallPlugin(pluginId) + +Uninstalls a plugin. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PluginsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PluginsApi apiInstance = new PluginsApi(defaultClient); + UUID pluginId = UUID.randomUUID(); // UUID | Plugin id. + try { + apiInstance.uninstallPlugin(pluginId); + } catch (ApiException e) { + System.err.println("Exception when calling PluginsApi#uninstallPlugin"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **pluginId** | **UUID**| Plugin id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Plugin uninstalled. | - | +| **404** | Plugin not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **uninstallPluginByVersion** +> uninstallPluginByVersion(pluginId, version) + +Uninstalls a plugin by version. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PluginsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PluginsApi apiInstance = new PluginsApi(defaultClient); + UUID pluginId = UUID.randomUUID(); // UUID | Plugin id. + String version = "version_example"; // String | Plugin version. + try { + apiInstance.uninstallPluginByVersion(pluginId, version); + } catch (ApiException e) { + System.err.println("Exception when calling PluginsApi#uninstallPluginByVersion"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **pluginId** | **UUID**| Plugin id. | | +| **version** | **String**| Plugin version. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Plugin uninstalled. | - | +| **404** | Plugin not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updatePluginConfiguration** +> updatePluginConfiguration(pluginId) + +Updates plugin configuration. + +Accepts plugin configuration as JSON body. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PluginsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + PluginsApi apiInstance = new PluginsApi(defaultClient); + UUID pluginId = UUID.randomUUID(); // UUID | Plugin id. + try { + apiInstance.updatePluginConfiguration(pluginId); + } catch (ApiException e) { + System.err.println("Exception when calling PluginsApi#updatePluginConfiguration"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **pluginId** | **UUID**| Plugin id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Plugin configuration updated. | - | +| **404** | Plugin not found or plugin does not have configuration. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PreviousItemRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PreviousItemRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PreviousItemRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PreviousItemRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ProblemDetails.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ProblemDetails.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ProblemDetails.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ProblemDetails.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ProcessPriorityClass.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ProcessPriorityClass.md new file mode 100644 index 0000000000000..8538f468c6277 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ProcessPriorityClass.md @@ -0,0 +1,21 @@ + + +# ProcessPriorityClass + +## Enum + + +* `NORMAL` (value: `"Normal"`) + +* `IDLE` (value: `"Idle"`) + +* `HIGH` (value: `"High"`) + +* `REAL_TIME` (value: `"RealTime"`) + +* `BELOW_NORMAL` (value: `"BelowNormal"`) + +* `ABOVE_NORMAL` (value: `"AboveNormal"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ProfileCondition.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ProfileCondition.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ProfileCondition.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ProfileCondition.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ProfileConditionType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ProfileConditionType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ProfileConditionType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ProfileConditionType.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ProfileConditionValue.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ProfileConditionValue.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ProfileConditionValue.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ProfileConditionValue.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ProgramAudio.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ProgramAudio.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ProgramAudio.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ProgramAudio.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PublicSystemInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PublicSystemInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/PublicSystemInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/PublicSystemInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/QueryFilters.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/QueryFilters.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/QueryFilters.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/QueryFilters.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/QueryFiltersLegacy.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/QueryFiltersLegacy.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/QueryFiltersLegacy.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/QueryFiltersLegacy.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/QueueItem.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/QueueItem.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/QueueItem.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/QueueItem.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/QueueRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/QueueRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/QueueRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/QueueRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/QuickConnectApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/QuickConnectApi.md new file mode 100644 index 0000000000000..03c56db67bae4 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/QuickConnectApi.md @@ -0,0 +1,257 @@ +# QuickConnectApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**authorizeQuickConnect**](QuickConnectApi.md#authorizeQuickConnect) | **POST** /QuickConnect/Authorize | Authorizes a pending quick connect request. | +| [**getQuickConnectEnabled**](QuickConnectApi.md#getQuickConnectEnabled) | **GET** /QuickConnect/Enabled | Gets the current quick connect state. | +| [**getQuickConnectState**](QuickConnectApi.md#getQuickConnectState) | **GET** /QuickConnect/Connect | Attempts to retrieve authentication information. | +| [**initiateQuickConnect**](QuickConnectApi.md#initiateQuickConnect) | **POST** /QuickConnect/Initiate | Initiate a new quick connect request. | + + + +# **authorizeQuickConnect** +> Boolean authorizeQuickConnect(code, userId) + +Authorizes a pending quick connect request. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QuickConnectApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + QuickConnectApi apiInstance = new QuickConnectApi(defaultClient); + String code = "code_example"; // String | Quick connect code to authorize. + UUID userId = UUID.randomUUID(); // UUID | The user the authorize. Access to the requested user is required. + try { + Boolean result = apiInstance.authorizeQuickConnect(code, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling QuickConnectApi#authorizeQuickConnect"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **code** | **String**| Quick connect code to authorize. | | +| **userId** | **UUID**| The user the authorize. Access to the requested user is required. | [optional] | + +### Return type + +**Boolean** + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Quick connect result authorized successfully. | - | +| **403** | Unknown user id. | - | +| **401** | Unauthorized | - | + + +# **getQuickConnectEnabled** +> Boolean getQuickConnectEnabled() + +Gets the current quick connect state. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QuickConnectApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + QuickConnectApi apiInstance = new QuickConnectApi(defaultClient); + try { + Boolean result = apiInstance.getQuickConnectEnabled(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling QuickConnectApi#getQuickConnectEnabled"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**Boolean** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Quick connect state returned. | - | + + +# **getQuickConnectState** +> QuickConnectResult getQuickConnectState(secret) + +Attempts to retrieve authentication information. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QuickConnectApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + QuickConnectApi apiInstance = new QuickConnectApi(defaultClient); + String secret = "secret_example"; // String | Secret previously returned from the Initiate endpoint. + try { + QuickConnectResult result = apiInstance.getQuickConnectState(secret); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling QuickConnectApi#getQuickConnectState"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **secret** | **String**| Secret previously returned from the Initiate endpoint. | | + +### Return type + +[**QuickConnectResult**](QuickConnectResult.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Quick connect result returned. | - | +| **404** | Unknown quick connect secret. | - | + + +# **initiateQuickConnect** +> QuickConnectResult initiateQuickConnect() + +Initiate a new quick connect request. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QuickConnectApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + QuickConnectApi apiInstance = new QuickConnectApi(defaultClient); + try { + QuickConnectResult result = apiInstance.initiateQuickConnect(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling QuickConnectApi#initiateQuickConnect"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**QuickConnectResult**](QuickConnectResult.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Quick connect request successfully created. | - | +| **401** | Quick connect is not active on this server. | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/QuickConnectDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/QuickConnectDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/QuickConnectDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/QuickConnectDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/QuickConnectResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/QuickConnectResult.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/QuickConnectResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/QuickConnectResult.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RatingType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RatingType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RatingType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RatingType.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ReadyRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ReadyRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ReadyRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ReadyRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RecommendationDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RecommendationDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RecommendationDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RecommendationDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RecommendationType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RecommendationType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RecommendationType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RecommendationType.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RecordingStatus.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RecordingStatus.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RecordingStatus.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RecordingStatus.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RefreshProgressMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RefreshProgressMessage.md new file mode 100644 index 0000000000000..aa313f6261eaf --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RefreshProgressMessage.md @@ -0,0 +1,16 @@ + + +# RefreshProgressMessage + +Refresh progress message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | **Map<String, String>** | Gets or sets the data. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoteImageApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoteImageApi.md new file mode 100644 index 0000000000000..99df1bda07516 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoteImageApi.md @@ -0,0 +1,234 @@ +# RemoteImageApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**downloadRemoteImage**](RemoteImageApi.md#downloadRemoteImage) | **POST** /Items/{itemId}/RemoteImages/Download | Downloads a remote image for an item. | +| [**getRemoteImageProviders**](RemoteImageApi.md#getRemoteImageProviders) | **GET** /Items/{itemId}/RemoteImages/Providers | Gets available remote image providers for an item. | +| [**getRemoteImages**](RemoteImageApi.md#getRemoteImages) | **GET** /Items/{itemId}/RemoteImages | Gets available remote images for an item. | + + + +# **downloadRemoteImage** +> downloadRemoteImage(itemId, type, imageUrl) + +Downloads a remote image for an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.RemoteImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + RemoteImageApi apiInstance = new RemoteImageApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item Id. + ImageType type = ImageType.fromValue("Primary"); // ImageType | The image type. + String imageUrl = "imageUrl_example"; // String | The image url. + try { + apiInstance.downloadRemoteImage(itemId, type, imageUrl); + } catch (ApiException e) { + System.err.println("Exception when calling RemoteImageApi#downloadRemoteImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item Id. | | +| **type** | **ImageType**| The image type. | [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **imageUrl** | **String**| The image url. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Remote image downloaded. | - | +| **404** | Remote image not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getRemoteImageProviders** +> List<ImageProviderInfo> getRemoteImageProviders(itemId) + +Gets available remote image providers for an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.RemoteImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + RemoteImageApi apiInstance = new RemoteImageApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item Id. + try { + List result = apiInstance.getRemoteImageProviders(itemId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling RemoteImageApi#getRemoteImageProviders"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item Id. | | + +### Return type + +[**List<ImageProviderInfo>**](ImageProviderInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returned remote image providers. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getRemoteImages** +> RemoteImageResult getRemoteImages(itemId, type, startIndex, limit, providerName, includeAllLanguages) + +Gets available remote images for an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.RemoteImageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + RemoteImageApi apiInstance = new RemoteImageApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item Id. + ImageType type = ImageType.fromValue("Primary"); // ImageType | The image type. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + String providerName = "providerName_example"; // String | Optional. The image provider to use. + Boolean includeAllLanguages = false; // Boolean | Optional. Include all languages. + try { + RemoteImageResult result = apiInstance.getRemoteImages(itemId, type, startIndex, limit, providerName, includeAllLanguages); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling RemoteImageApi#getRemoteImages"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item Id. | | +| **type** | **ImageType**| The image type. | [optional] [enum: Primary, Art, Backdrop, Banner, Logo, Thumb, Disc, Box, Screenshot, Menu, Chapter, BoxRear, Profile] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **providerName** | **String**| Optional. The image provider to use. | [optional] | +| **includeAllLanguages** | **Boolean**| Optional. Include all languages. | [optional] [default to false] | + +### Return type + +[**RemoteImageResult**](RemoteImageResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Remote Images returned. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RemoteImageInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoteImageInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RemoteImageInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoteImageInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RemoteImageResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoteImageResult.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RemoteImageResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoteImageResult.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoteLyricInfoDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoteLyricInfoDto.md new file mode 100644 index 0000000000000..4c3ca188201b9 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoteLyricInfoDto.md @@ -0,0 +1,16 @@ + + +# RemoteLyricInfoDto + +The remote lyric info dto. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**id** | **String** | Gets or sets the id for the lyric. | [optional] | +|**providerName** | **String** | Gets the provider name. | [optional] | +|**lyrics** | [**LyricDto**](LyricDto.md) | Gets the lyrics. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RemoteSearchResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoteSearchResult.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RemoteSearchResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoteSearchResult.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoteSubtitleInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoteSubtitleInfo.md new file mode 100644 index 0000000000000..3f0c7fd8019c0 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoteSubtitleInfo.md @@ -0,0 +1,28 @@ + + +# RemoteSubtitleInfo + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**threeLetterISOLanguageName** | **String** | | [optional] | +|**id** | **String** | | [optional] | +|**providerName** | **String** | | [optional] | +|**name** | **String** | | [optional] | +|**format** | **String** | | [optional] | +|**author** | **String** | | [optional] | +|**comment** | **String** | | [optional] | +|**dateCreated** | **OffsetDateTime** | | [optional] | +|**communityRating** | **Float** | | [optional] | +|**frameRate** | **Float** | | [optional] | +|**downloadCount** | **Integer** | | [optional] | +|**isHashMatch** | **Boolean** | | [optional] | +|**aiTranslated** | **Boolean** | | [optional] | +|**machineTranslated** | **Boolean** | | [optional] | +|**forced** | **Boolean** | | [optional] | +|**hearingImpaired** | **Boolean** | | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/RemoveFromPlaylistRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoveFromPlaylistRequestDto.md similarity index 90% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/RemoveFromPlaylistRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoveFromPlaylistRequestDto.md index bbf21a6dfeede..722d32e0b84b6 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/RemoveFromPlaylistRequestDto.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RemoveFromPlaylistRequestDto.md @@ -8,7 +8,7 @@ Class RemoveFromPlaylistRequestDto. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**playlistItemIds** | **List<UUID>** | Gets or sets the playlist identifiers ot the items. Ignored when clearing the playlist. | [optional] | +|**playlistItemIds** | **List<UUID>** | Gets or sets the playlist identifiers of the items. Ignored when clearing the playlist. | [optional] | |**clearPlaylist** | **Boolean** | Gets or sets a value indicating whether the entire playlist should be cleared. | [optional] | |**clearPlayingItem** | **Boolean** | Gets or sets a value indicating whether the playing item should be removed as well. Used only when clearing the playlist. | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RepeatMode.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RepeatMode.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RepeatMode.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RepeatMode.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RepositoryInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RepositoryInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/RepositoryInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RepositoryInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RestartRequiredMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RestartRequiredMessage.md new file mode 100644 index 0000000000000..6ed459b408aee --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/RestartRequiredMessage.md @@ -0,0 +1,15 @@ + + +# RestartRequiredMessage + +Restart required. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScheduledTaskEndedMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScheduledTaskEndedMessage.md new file mode 100644 index 0000000000000..2ce25ee995ce3 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScheduledTaskEndedMessage.md @@ -0,0 +1,16 @@ + + +# ScheduledTaskEndedMessage + +Scheduled task ended message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**TaskResult**](TaskResult.md) | Class TaskExecutionInfo. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScheduledTasksApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScheduledTasksApi.md new file mode 100644 index 0000000000000..98b1586f22439 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScheduledTasksApi.md @@ -0,0 +1,363 @@ +# ScheduledTasksApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getTask**](ScheduledTasksApi.md#getTask) | **GET** /ScheduledTasks/{taskId} | Get task by id. | +| [**getTasks**](ScheduledTasksApi.md#getTasks) | **GET** /ScheduledTasks | Get tasks. | +| [**startTask**](ScheduledTasksApi.md#startTask) | **POST** /ScheduledTasks/Running/{taskId} | Start specified task. | +| [**stopTask**](ScheduledTasksApi.md#stopTask) | **DELETE** /ScheduledTasks/Running/{taskId} | Stop specified task. | +| [**updateTask**](ScheduledTasksApi.md#updateTask) | **POST** /ScheduledTasks/{taskId}/Triggers | Update specified task triggers. | + + + +# **getTask** +> TaskInfo getTask(taskId) + +Get task by id. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ScheduledTasksApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ScheduledTasksApi apiInstance = new ScheduledTasksApi(defaultClient); + String taskId = "taskId_example"; // String | Task Id. + try { + TaskInfo result = apiInstance.getTask(taskId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ScheduledTasksApi#getTask"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **taskId** | **String**| Task Id. | | + +### Return type + +[**TaskInfo**](TaskInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Task retrieved. | - | +| **404** | Task not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getTasks** +> List<TaskInfo> getTasks(isHidden, isEnabled) + +Get tasks. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ScheduledTasksApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ScheduledTasksApi apiInstance = new ScheduledTasksApi(defaultClient); + Boolean isHidden = true; // Boolean | Optional filter tasks that are hidden, or not. + Boolean isEnabled = true; // Boolean | Optional filter tasks that are enabled, or not. + try { + List result = apiInstance.getTasks(isHidden, isEnabled); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ScheduledTasksApi#getTasks"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **isHidden** | **Boolean**| Optional filter tasks that are hidden, or not. | [optional] | +| **isEnabled** | **Boolean**| Optional filter tasks that are enabled, or not. | [optional] | + +### Return type + +[**List<TaskInfo>**](TaskInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Scheduled tasks retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **startTask** +> startTask(taskId) + +Start specified task. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ScheduledTasksApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ScheduledTasksApi apiInstance = new ScheduledTasksApi(defaultClient); + String taskId = "taskId_example"; // String | Task Id. + try { + apiInstance.startTask(taskId); + } catch (ApiException e) { + System.err.println("Exception when calling ScheduledTasksApi#startTask"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **taskId** | **String**| Task Id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Task started. | - | +| **404** | Task not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **stopTask** +> stopTask(taskId) + +Stop specified task. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ScheduledTasksApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ScheduledTasksApi apiInstance = new ScheduledTasksApi(defaultClient); + String taskId = "taskId_example"; // String | Task Id. + try { + apiInstance.stopTask(taskId); + } catch (ApiException e) { + System.err.println("Exception when calling ScheduledTasksApi#stopTask"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **taskId** | **String**| Task Id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Task stopped. | - | +| **404** | Task not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateTask** +> updateTask(taskId, taskTriggerInfo) + +Update specified task triggers. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.ScheduledTasksApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + ScheduledTasksApi apiInstance = new ScheduledTasksApi(defaultClient); + String taskId = "taskId_example"; // String | Task Id. + List taskTriggerInfo = Arrays.asList(); // List | Triggers. + try { + apiInstance.updateTask(taskId, taskTriggerInfo); + } catch (ApiException e) { + System.err.println("Exception when calling ScheduledTasksApi#updateTask"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **taskId** | **String**| Task Id. | | +| **taskTriggerInfo** | [**List<TaskTriggerInfo>**](TaskTriggerInfo.md)| Triggers. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Task triggers updated. | - | +| **404** | Task not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScheduledTasksInfoMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScheduledTasksInfoMessage.md new file mode 100644 index 0000000000000..79c5488c0282f --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScheduledTasksInfoMessage.md @@ -0,0 +1,16 @@ + + +# ScheduledTasksInfoMessage + +Scheduled tasks info message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**List<TaskInfo>**](TaskInfo.md) | Gets or sets the data. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScheduledTasksInfoStartMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScheduledTasksInfoStartMessage.md new file mode 100644 index 0000000000000..9b57533f51d3c --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScheduledTasksInfoStartMessage.md @@ -0,0 +1,15 @@ + + +# ScheduledTasksInfoStartMessage + +Scheduled tasks info start message. Data is the timing data encoded as \"$initialDelay,$interval\" in ms. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | **String** | Gets or sets the data. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScheduledTasksInfoStopMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScheduledTasksInfoStopMessage.md new file mode 100644 index 0000000000000..60b03b15e7f36 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScheduledTasksInfoStopMessage.md @@ -0,0 +1,14 @@ + + +# ScheduledTasksInfoStopMessage + +Scheduled tasks info stop message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ScrollDirection.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScrollDirection.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ScrollDirection.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ScrollDirection.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SearchApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SearchApi.md new file mode 100644 index 0000000000000..27452c60de0cf --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SearchApi.md @@ -0,0 +1,112 @@ +# SearchApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getSearchHints**](SearchApi.md#getSearchHints) | **GET** /Search/Hints | Gets the search hint result. | + + + +# **getSearchHints** +> SearchHintResult getSearchHints(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists) + +Gets the search hint result. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SearchApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SearchApi apiInstance = new SearchApi(defaultClient); + String searchTerm = "searchTerm_example"; // String | The search term to filter on. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + UUID userId = UUID.randomUUID(); // UUID | Optional. Supply a user id to search within a user's library or omit to search all. + List includeItemTypes = Arrays.asList(); // List | If specified, only results with the specified item types are returned. This allows multiple, comma delimited. + List excludeItemTypes = Arrays.asList(); // List | If specified, results with these item types are filtered out. This allows multiple, comma delimited. + List mediaTypes = Arrays.asList(); // List | If specified, only results with the specified media types are returned. This allows multiple, comma delimited. + UUID parentId = UUID.randomUUID(); // UUID | If specified, only children of the parent are returned. + Boolean isMovie = true; // Boolean | Optional filter for movies. + Boolean isSeries = true; // Boolean | Optional filter for series. + Boolean isNews = true; // Boolean | Optional filter for news. + Boolean isKids = true; // Boolean | Optional filter for kids. + Boolean isSports = true; // Boolean | Optional filter for sports. + Boolean includePeople = true; // Boolean | Optional filter whether to include people. + Boolean includeMedia = true; // Boolean | Optional filter whether to include media. + Boolean includeGenres = true; // Boolean | Optional filter whether to include genres. + Boolean includeStudios = true; // Boolean | Optional filter whether to include studios. + Boolean includeArtists = true; // Boolean | Optional filter whether to include artists. + try { + SearchHintResult result = apiInstance.getSearchHints(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SearchApi#getSearchHints"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **searchTerm** | **String**| The search term to filter on. | | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **userId** | **UUID**| Optional. Supply a user id to search within a user's library or omit to search all. | [optional] | +| **includeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| If specified, only results with the specified item types are returned. This allows multiple, comma delimited. | [optional] | +| **excludeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| If specified, results with these item types are filtered out. This allows multiple, comma delimited. | [optional] | +| **mediaTypes** | [**List<MediaType>**](MediaType.md)| If specified, only results with the specified media types are returned. This allows multiple, comma delimited. | [optional] | +| **parentId** | **UUID**| If specified, only children of the parent are returned. | [optional] | +| **isMovie** | **Boolean**| Optional filter for movies. | [optional] | +| **isSeries** | **Boolean**| Optional filter for series. | [optional] | +| **isNews** | **Boolean**| Optional filter for news. | [optional] | +| **isKids** | **Boolean**| Optional filter for kids. | [optional] | +| **isSports** | **Boolean**| Optional filter for sports. | [optional] | +| **includePeople** | **Boolean**| Optional filter whether to include people. | [optional] [default to true] | +| **includeMedia** | **Boolean**| Optional filter whether to include media. | [optional] [default to true] | +| **includeGenres** | **Boolean**| Optional filter whether to include genres. | [optional] [default to true] | +| **includeStudios** | **Boolean**| Optional filter whether to include studios. | [optional] [default to true] | +| **includeArtists** | **Boolean**| Optional filter whether to include artists. | [optional] [default to true] | + +### Return type + +[**SearchHintResult**](SearchHintResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Search hint returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/SearchHint.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SearchHint.md similarity index 75% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/SearchHint.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SearchHint.md index 1110ed6ebe49f..5e2d93c6d5403 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/SearchHint.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SearchHint.md @@ -9,7 +9,7 @@ Class SearchHintResult. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| |**itemId** | **UUID** | Gets or sets the item id. | [optional] | -|**id** | **UUID** | | [optional] | +|**id** | **UUID** | Gets or sets the item id. | [optional] | |**name** | **String** | Gets or sets the name. | [optional] | |**matchedTerm** | **String** | Gets or sets the matched term. | [optional] | |**indexNumber** | **Integer** | Gets or sets the index number. | [optional] | @@ -20,16 +20,16 @@ Class SearchHintResult. |**thumbImageItemId** | **String** | Gets or sets the thumb image item identifier. | [optional] | |**backdropImageTag** | **String** | Gets or sets the backdrop image tag. | [optional] | |**backdropImageItemId** | **String** | Gets or sets the backdrop image item identifier. | [optional] | -|**type** | **String** | Gets or sets the type. | [optional] | -|**isFolder** | **Boolean** | | [optional] | +|**type** | **BaseItemKind** | The base item kind. | [optional] | +|**isFolder** | **Boolean** | Gets or sets a value indicating whether this instance is folder. | [optional] | |**runTimeTicks** | **Long** | Gets or sets the run time ticks. | [optional] | -|**mediaType** | **String** | Gets or sets the type of the media. | [optional] | -|**startDate** | **OffsetDateTime** | | [optional] | -|**endDate** | **OffsetDateTime** | | [optional] | +|**mediaType** | **MediaType** | Media types. | [optional] | +|**startDate** | **OffsetDateTime** | Gets or sets the start date. | [optional] | +|**endDate** | **OffsetDateTime** | Gets or sets the end date. | [optional] | |**series** | **String** | Gets or sets the series. | [optional] | -|**status** | **String** | | [optional] | +|**status** | **String** | Gets or sets the status. | [optional] | |**album** | **String** | Gets or sets the album. | [optional] | -|**albumId** | **UUID** | | [optional] | +|**albumId** | **UUID** | Gets or sets the album id. | [optional] | |**albumArtist** | **String** | Gets or sets the album artist. | [optional] | |**artists** | **List<String>** | Gets or sets the artists. | [optional] | |**songCount** | **Integer** | Gets or sets the song count. | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SearchHintResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SearchHintResult.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SearchHintResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SearchHintResult.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SeekRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeekRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SeekRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeekRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SendCommand.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SendCommand.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SendCommand.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SendCommand.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SendCommandType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SendCommandType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SendCommandType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SendCommandType.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SeriesInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SeriesInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SeriesInfoRemoteSearchQuery.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesInfoRemoteSearchQuery.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SeriesInfoRemoteSearchQuery.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesInfoRemoteSearchQuery.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesStatus.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesStatus.md new file mode 100644 index 0000000000000..20fcf4ad30889 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesStatus.md @@ -0,0 +1,15 @@ + + +# SeriesStatus + +## Enum + + +* `CONTINUING` (value: `"Continuing"`) + +* `ENDED` (value: `"Ended"`) + +* `UNRELEASED` (value: `"Unreleased"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesTimerCancelledMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesTimerCancelledMessage.md new file mode 100644 index 0000000000000..82e086f34ba7a --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesTimerCancelledMessage.md @@ -0,0 +1,16 @@ + + +# SeriesTimerCancelledMessage + +Series timer cancelled message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**TimerEventInfo**](TimerEventInfo.md) | Gets or sets the data. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesTimerCreatedMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesTimerCreatedMessage.md new file mode 100644 index 0000000000000..5410e96127d98 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesTimerCreatedMessage.md @@ -0,0 +1,16 @@ + + +# SeriesTimerCreatedMessage + +Series timer created message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**TimerEventInfo**](TimerEventInfo.md) | Gets or sets the data. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SeriesTimerInfoDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesTimerInfoDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SeriesTimerInfoDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesTimerInfoDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/SeriesTimerInfoDtoQueryResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesTimerInfoDtoQueryResult.md similarity index 95% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/SeriesTimerInfoDtoQueryResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesTimerInfoDtoQueryResult.md index 157c3127d7c91..16c0ed89d3cef 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/SeriesTimerInfoDtoQueryResult.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SeriesTimerInfoDtoQueryResult.md @@ -2,6 +2,7 @@ # SeriesTimerInfoDtoQueryResult +Query result container. ## Properties diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/ServerConfiguration.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ServerConfiguration.md similarity index 84% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/ServerConfiguration.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ServerConfiguration.md index 79b6ef593023a..7b47917baaf18 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/ServerConfiguration.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ServerConfiguration.md @@ -20,7 +20,6 @@ Represents the server configuration. |**enableCaseSensitiveItemIds** | **Boolean** | Gets or sets a value indicating whether [enable case sensitive item ids]. | [optional] | |**disableLiveTvChannelUserDataName** | **Boolean** | | [optional] | |**metadataPath** | **String** | Gets or sets the metadata path. | [optional] | -|**metadataNetworkPath** | **String** | | [optional] | |**preferredMetadataLanguage** | **String** | Gets or sets the preferred metadata language. | [optional] | |**metadataCountryCode** | **String** | Gets or sets the metadata country code. | [optional] | |**sortReplaceCharacters** | **List<String>** | Gets or sets characters to be replaced with a ' ' in strings to create a sort name. | [optional] | @@ -31,7 +30,9 @@ Represents the server configuration. |**minResumeDurationSeconds** | **Integer** | Gets or sets the minimum duration that an item must have in order to be eligible for playstate updates.. | [optional] | |**minAudiobookResume** | **Integer** | Gets or sets the minimum minutes of a book that must be played in order for playstate to be updated. | [optional] | |**maxAudiobookResume** | **Integer** | Gets or sets the remaining minutes of a book that can be played while still saving playstate. If this percentage is crossed playstate will be reset to the beginning and the item will be marked watched. | [optional] | +|**inactiveSessionThreshold** | **Integer** | Gets or sets the threshold in minutes after a inactive session gets closed automatically. If set to 0 the check for inactive sessions gets disabled. | [optional] | |**libraryMonitorDelay** | **Integer** | Gets or sets the delay in seconds that we will wait after a file system change to try and discover what has been added/removed Some delay is necessary with some items because their creation is not atomic. It involves the creation of several different directories and files. | [optional] | +|**libraryUpdateDuration** | **Integer** | Gets or sets the duration in seconds that we will wait after a library updated event before executing the library changed notification. | [optional] | |**imageSavingConvention** | **ImageSavingConvention** | Gets or sets the image saving convention. | [optional] | |**metadataOptions** | [**List<MetadataOptions>**](MetadataOptions.md) | | [optional] | |**skipDeserializationForBasicTypes** | **Boolean** | | [optional] | @@ -56,6 +57,11 @@ Represents the server configuration. |**libraryMetadataRefreshConcurrency** | **Integer** | Gets or sets the how many metadata refreshes can run concurrently. | [optional] | |**removeOldPlugins** | **Boolean** | Gets or sets a value indicating whether older plugins should automatically be deleted from the plugin folder. | [optional] | |**allowClientLogUpload** | **Boolean** | Gets or sets a value indicating whether clients should be allowed to upload logs. | [optional] | +|**dummyChapterDuration** | **Integer** | Gets or sets the dummy chapter duration in seconds, use 0 (zero) or less to disable generation alltogether. | [optional] | +|**chapterImageResolution** | **ImageResolution** | Gets or sets the chapter image resolution. | [optional] | +|**parallelImageEncodingLimit** | **Integer** | Gets or sets the limit for parallel image encoding. | [optional] | +|**castReceiverApplications** | [**List<CastReceiverApplication>**](CastReceiverApplication.md) | Gets or sets the list of cast receiver applications. | [optional] | +|**trickplayOptions** | [**TrickplayOptions**](TrickplayOptions.md) | Gets or sets the trickplay options. | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ServerDiscoveryInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ServerDiscoveryInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ServerDiscoveryInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ServerDiscoveryInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ServerRestartingMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ServerRestartingMessage.md new file mode 100644 index 0000000000000..d405114f141c0 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ServerRestartingMessage.md @@ -0,0 +1,15 @@ + + +# ServerRestartingMessage + +Server restarting down message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ServerShuttingDownMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ServerShuttingDownMessage.md new file mode 100644 index 0000000000000..eac2462247bf5 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ServerShuttingDownMessage.md @@ -0,0 +1,15 @@ + + +# ServerShuttingDownMessage + +Server shutting down message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionApi.md new file mode 100644 index 0000000000000..7e234a2f2efc6 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionApi.md @@ -0,0 +1,1157 @@ +# SessionApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**addUserToSession**](SessionApi.md#addUserToSession) | **POST** /Sessions/{sessionId}/User/{userId} | Adds an additional user to a session. | +| [**displayContent**](SessionApi.md#displayContent) | **POST** /Sessions/{sessionId}/Viewing | Instructs a session to browse to an item or view. | +| [**getAuthProviders**](SessionApi.md#getAuthProviders) | **GET** /Auth/Providers | Get all auth providers. | +| [**getPasswordResetProviders**](SessionApi.md#getPasswordResetProviders) | **GET** /Auth/PasswordResetProviders | Get all password reset providers. | +| [**getSessions**](SessionApi.md#getSessions) | **GET** /Sessions | Gets a list of sessions. | +| [**play**](SessionApi.md#play) | **POST** /Sessions/{sessionId}/Playing | Instructs a session to play an item. | +| [**postCapabilities**](SessionApi.md#postCapabilities) | **POST** /Sessions/Capabilities | Updates capabilities for a device. | +| [**postFullCapabilities**](SessionApi.md#postFullCapabilities) | **POST** /Sessions/Capabilities/Full | Updates capabilities for a device. | +| [**removeUserFromSession**](SessionApi.md#removeUserFromSession) | **DELETE** /Sessions/{sessionId}/User/{userId} | Removes an additional user from a session. | +| [**reportSessionEnded**](SessionApi.md#reportSessionEnded) | **POST** /Sessions/Logout | Reports that a session has ended. | +| [**reportViewing**](SessionApi.md#reportViewing) | **POST** /Sessions/Viewing | Reports that a session is viewing an item. | +| [**sendFullGeneralCommand**](SessionApi.md#sendFullGeneralCommand) | **POST** /Sessions/{sessionId}/Command | Issues a full general command to a client. | +| [**sendGeneralCommand**](SessionApi.md#sendGeneralCommand) | **POST** /Sessions/{sessionId}/Command/{command} | Issues a general command to a client. | +| [**sendMessageCommand**](SessionApi.md#sendMessageCommand) | **POST** /Sessions/{sessionId}/Message | Issues a command to a client to display a message to the user. | +| [**sendPlaystateCommand**](SessionApi.md#sendPlaystateCommand) | **POST** /Sessions/{sessionId}/Playing/{command} | Issues a playstate command to a client. | +| [**sendSystemCommand**](SessionApi.md#sendSystemCommand) | **POST** /Sessions/{sessionId}/System/{command} | Issues a system command to a client. | + + + +# **addUserToSession** +> addUserToSession(sessionId, userId) + +Adds an additional user to a session. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + String sessionId = "sessionId_example"; // String | The session id. + UUID userId = UUID.randomUUID(); // UUID | The user id. + try { + apiInstance.addUserToSession(sessionId, userId); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#addUserToSession"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **sessionId** | **String**| The session id. | | +| **userId** | **UUID**| The user id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | User added to session. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **displayContent** +> displayContent(sessionId, itemType, itemId, itemName) + +Instructs a session to browse to an item or view. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + String sessionId = "sessionId_example"; // String | The session Id. + BaseItemKind itemType = BaseItemKind.fromValue("AggregateFolder"); // BaseItemKind | The type of item to browse to. + String itemId = "itemId_example"; // String | The Id of the item. + String itemName = "itemName_example"; // String | The name of the item. + try { + apiInstance.displayContent(sessionId, itemType, itemId, itemName); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#displayContent"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **sessionId** | **String**| The session Id. | | +| **itemType** | **BaseItemKind**| The type of item to browse to. | [enum: AggregateFolder, Audio, AudioBook, BasePluginFolder, Book, BoxSet, Channel, ChannelFolderItem, CollectionFolder, Episode, Folder, Genre, ManualPlaylistsFolder, Movie, LiveTvChannel, LiveTvProgram, MusicAlbum, MusicArtist, MusicGenre, MusicVideo, Person, Photo, PhotoAlbum, Playlist, PlaylistsFolder, Program, Recording, Season, Series, Studio, Trailer, TvChannel, TvProgram, UserRootFolder, UserView, Video, Year] | +| **itemId** | **String**| The Id of the item. | | +| **itemName** | **String**| The name of the item. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Instruction sent to session. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getAuthProviders** +> List<NameIdPair> getAuthProviders() + +Get all auth providers. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + try { + List result = apiInstance.getAuthProviders(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#getAuthProviders"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<NameIdPair>**](NameIdPair.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Auth providers retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPasswordResetProviders** +> List<NameIdPair> getPasswordResetProviders() + +Get all password reset providers. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + try { + List result = apiInstance.getPasswordResetProviders(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#getPasswordResetProviders"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<NameIdPair>**](NameIdPair.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Password reset providers retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getSessions** +> List<SessionInfoDto> getSessions(controllableByUserId, deviceId, activeWithinSeconds) + +Gets a list of sessions. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + UUID controllableByUserId = UUID.randomUUID(); // UUID | Filter by sessions that a given user is allowed to remote control. + String deviceId = "deviceId_example"; // String | Filter by device Id. + Integer activeWithinSeconds = 56; // Integer | Optional. Filter by sessions that were active in the last n seconds. + try { + List result = apiInstance.getSessions(controllableByUserId, deviceId, activeWithinSeconds); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#getSessions"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **controllableByUserId** | **UUID**| Filter by sessions that a given user is allowed to remote control. | [optional] | +| **deviceId** | **String**| Filter by device Id. | [optional] | +| **activeWithinSeconds** | **Integer**| Optional. Filter by sessions that were active in the last n seconds. | [optional] | + +### Return type + +[**List<SessionInfoDto>**](SessionInfoDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | List of sessions returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **play** +> play(sessionId, playCommand, itemIds, startPositionTicks, mediaSourceId, audioStreamIndex, subtitleStreamIndex, startIndex) + +Instructs a session to play an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + String sessionId = "sessionId_example"; // String | The session id. + PlayCommand playCommand = PlayCommand.fromValue("PlayNow"); // PlayCommand | The type of play command to issue (PlayNow, PlayNext, PlayLast). Clients who have not yet implemented play next and play last may play now. + List itemIds = Arrays.asList(); // List | The ids of the items to play, comma delimited. + Long startPositionTicks = 56L; // Long | The starting position of the first item. + String mediaSourceId = "mediaSourceId_example"; // String | Optional. The media source id. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to play. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to play. + Integer startIndex = 56; // Integer | Optional. The start index. + try { + apiInstance.play(sessionId, playCommand, itemIds, startPositionTicks, mediaSourceId, audioStreamIndex, subtitleStreamIndex, startIndex); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#play"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **sessionId** | **String**| The session id. | | +| **playCommand** | **PlayCommand**| The type of play command to issue (PlayNow, PlayNext, PlayLast). Clients who have not yet implemented play next and play last may play now. | [enum: PlayNow, PlayNext, PlayLast, PlayInstantMix, PlayShuffle] | +| **itemIds** | [**List<UUID>**](UUID.md)| The ids of the items to play, comma delimited. | | +| **startPositionTicks** | **Long**| The starting position of the first item. | [optional] | +| **mediaSourceId** | **String**| Optional. The media source id. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to play. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to play. | [optional] | +| **startIndex** | **Integer**| Optional. The start index. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Instruction sent to session. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **postCapabilities** +> postCapabilities(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsPersistentIdentifier) + +Updates capabilities for a device. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + String id = "id_example"; // String | The session id. + List playableMediaTypes = Arrays.asList(); // List | A list of playable media types, comma delimited. Audio, Video, Book, Photo. + List supportedCommands = Arrays.asList(); // List | A list of supported remote control commands, comma delimited. + Boolean supportsMediaControl = false; // Boolean | Determines whether media can be played remotely.. + Boolean supportsPersistentIdentifier = true; // Boolean | Determines whether the device supports a unique identifier. + try { + apiInstance.postCapabilities(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsPersistentIdentifier); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#postCapabilities"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **id** | **String**| The session id. | [optional] | +| **playableMediaTypes** | [**List<MediaType>**](MediaType.md)| A list of playable media types, comma delimited. Audio, Video, Book, Photo. | [optional] | +| **supportedCommands** | [**List<GeneralCommandType>**](GeneralCommandType.md)| A list of supported remote control commands, comma delimited. | [optional] | +| **supportsMediaControl** | **Boolean**| Determines whether media can be played remotely.. | [optional] [default to false] | +| **supportsPersistentIdentifier** | **Boolean**| Determines whether the device supports a unique identifier. | [optional] [default to true] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Capabilities posted. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **postFullCapabilities** +> postFullCapabilities(clientCapabilitiesDto, id) + +Updates capabilities for a device. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + ClientCapabilitiesDto clientCapabilitiesDto = new ClientCapabilitiesDto(); // ClientCapabilitiesDto | The MediaBrowser.Model.Session.ClientCapabilities. + String id = "id_example"; // String | The session id. + try { + apiInstance.postFullCapabilities(clientCapabilitiesDto, id); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#postFullCapabilities"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **clientCapabilitiesDto** | [**ClientCapabilitiesDto**](ClientCapabilitiesDto.md)| The MediaBrowser.Model.Session.ClientCapabilities. | | +| **id** | **String**| The session id. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Capabilities updated. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **removeUserFromSession** +> removeUserFromSession(sessionId, userId) + +Removes an additional user from a session. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + String sessionId = "sessionId_example"; // String | The session id. + UUID userId = UUID.randomUUID(); // UUID | The user id. + try { + apiInstance.removeUserFromSession(sessionId, userId); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#removeUserFromSession"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **sessionId** | **String**| The session id. | | +| **userId** | **UUID**| The user id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | User removed from session. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **reportSessionEnded** +> reportSessionEnded() + +Reports that a session has ended. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + try { + apiInstance.reportSessionEnded(); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#reportSessionEnded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Session end reported to server. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **reportViewing** +> reportViewing(itemId, sessionId) + +Reports that a session is viewing an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + String itemId = "itemId_example"; // String | The item id. + String sessionId = "sessionId_example"; // String | The session id. + try { + apiInstance.reportViewing(itemId, sessionId); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#reportViewing"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **String**| The item id. | | +| **sessionId** | **String**| The session id. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Session reported to server. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **sendFullGeneralCommand** +> sendFullGeneralCommand(sessionId, generalCommand) + +Issues a full general command to a client. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + String sessionId = "sessionId_example"; // String | The session id. + GeneralCommand generalCommand = new GeneralCommand(); // GeneralCommand | The MediaBrowser.Model.Session.GeneralCommand. + try { + apiInstance.sendFullGeneralCommand(sessionId, generalCommand); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#sendFullGeneralCommand"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **sessionId** | **String**| The session id. | | +| **generalCommand** | [**GeneralCommand**](GeneralCommand.md)| The MediaBrowser.Model.Session.GeneralCommand. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Full general command sent to session. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **sendGeneralCommand** +> sendGeneralCommand(sessionId, command) + +Issues a general command to a client. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + String sessionId = "sessionId_example"; // String | The session id. + GeneralCommandType command = GeneralCommandType.fromValue("MoveUp"); // GeneralCommandType | The command to send. + try { + apiInstance.sendGeneralCommand(sessionId, command); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#sendGeneralCommand"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **sessionId** | **String**| The session id. | | +| **command** | **GeneralCommandType**| The command to send. | [enum: MoveUp, MoveDown, MoveLeft, MoveRight, PageUp, PageDown, PreviousLetter, NextLetter, ToggleOsd, ToggleContextMenu, Select, Back, TakeScreenshot, SendKey, SendString, GoHome, GoToSettings, VolumeUp, VolumeDown, Mute, Unmute, ToggleMute, SetVolume, SetAudioStreamIndex, SetSubtitleStreamIndex, ToggleFullscreen, DisplayContent, GoToSearch, DisplayMessage, SetRepeatMode, ChannelUp, ChannelDown, Guide, ToggleStats, PlayMediaSource, PlayTrailers, SetShuffleQueue, PlayState, PlayNext, ToggleOsdMenu, Play, SetMaxStreamingBitrate, SetPlaybackOrder] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | General command sent to session. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **sendMessageCommand** +> sendMessageCommand(sessionId, messageCommand) + +Issues a command to a client to display a message to the user. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + String sessionId = "sessionId_example"; // String | The session id. + MessageCommand messageCommand = new MessageCommand(); // MessageCommand | The MediaBrowser.Model.Session.MessageCommand object containing Header, Message Text, and TimeoutMs. + try { + apiInstance.sendMessageCommand(sessionId, messageCommand); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#sendMessageCommand"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **sessionId** | **String**| The session id. | | +| **messageCommand** | [**MessageCommand**](MessageCommand.md)| The MediaBrowser.Model.Session.MessageCommand object containing Header, Message Text, and TimeoutMs. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Message sent. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **sendPlaystateCommand** +> sendPlaystateCommand(sessionId, command, seekPositionTicks, controllingUserId) + +Issues a playstate command to a client. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + String sessionId = "sessionId_example"; // String | The session id. + PlaystateCommand command = PlaystateCommand.fromValue("Stop"); // PlaystateCommand | The MediaBrowser.Model.Session.PlaystateCommand. + Long seekPositionTicks = 56L; // Long | The optional position ticks. + String controllingUserId = "controllingUserId_example"; // String | The optional controlling user id. + try { + apiInstance.sendPlaystateCommand(sessionId, command, seekPositionTicks, controllingUserId); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#sendPlaystateCommand"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **sessionId** | **String**| The session id. | | +| **command** | **PlaystateCommand**| The MediaBrowser.Model.Session.PlaystateCommand. | [enum: Stop, Pause, Unpause, NextTrack, PreviousTrack, Seek, Rewind, FastForward, PlayPause] | +| **seekPositionTicks** | **Long**| The optional position ticks. | [optional] | +| **controllingUserId** | **String**| The optional controlling user id. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Playstate command sent to session. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **sendSystemCommand** +> sendSystemCommand(sessionId, command) + +Issues a system command to a client. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SessionApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SessionApi apiInstance = new SessionApi(defaultClient); + String sessionId = "sessionId_example"; // String | The session id. + GeneralCommandType command = GeneralCommandType.fromValue("MoveUp"); // GeneralCommandType | The command to send. + try { + apiInstance.sendSystemCommand(sessionId, command); + } catch (ApiException e) { + System.err.println("Exception when calling SessionApi#sendSystemCommand"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **sessionId** | **String**| The session id. | | +| **command** | **GeneralCommandType**| The command to send. | [enum: MoveUp, MoveDown, MoveLeft, MoveRight, PageUp, PageDown, PreviousLetter, NextLetter, ToggleOsd, ToggleContextMenu, Select, Back, TakeScreenshot, SendKey, SendString, GoHome, GoToSettings, VolumeUp, VolumeDown, Mute, Unmute, ToggleMute, SetVolume, SetAudioStreamIndex, SetSubtitleStreamIndex, ToggleFullscreen, DisplayContent, GoToSearch, DisplayMessage, SetRepeatMode, ChannelUp, ChannelDown, Guide, ToggleStats, PlayMediaSource, PlayTrailers, SetShuffleQueue, PlayState, PlayNext, ToggleOsdMenu, Play, SetMaxStreamingBitrate, SetPlaybackOrder] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | System command sent to session. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionInfoDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionInfoDto.md new file mode 100644 index 0000000000000..903b5f57ac0c6 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionInfoDto.md @@ -0,0 +1,42 @@ + + +# SessionInfoDto + +Session info DTO. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**playState** | [**PlayerStateInfo**](PlayerStateInfo.md) | Gets or sets the play state. | [optional] | +|**additionalUsers** | [**List<SessionUserInfo>**](SessionUserInfo.md) | Gets or sets the additional users. | [optional] | +|**capabilities** | [**ClientCapabilitiesDto**](ClientCapabilitiesDto.md) | Gets or sets the client capabilities. | [optional] | +|**remoteEndPoint** | **String** | Gets or sets the remote end point. | [optional] | +|**playableMediaTypes** | **List<MediaType>** | Gets or sets the playable media types. | [optional] | +|**id** | **String** | Gets or sets the id. | [optional] | +|**userId** | **UUID** | Gets or sets the user id. | [optional] | +|**userName** | **String** | Gets or sets the username. | [optional] | +|**client** | **String** | Gets or sets the type of the client. | [optional] | +|**lastActivityDate** | **OffsetDateTime** | Gets or sets the last activity date. | [optional] | +|**lastPlaybackCheckIn** | **OffsetDateTime** | Gets or sets the last playback check in. | [optional] | +|**lastPausedDate** | **OffsetDateTime** | Gets or sets the last paused date. | [optional] | +|**deviceName** | **String** | Gets or sets the name of the device. | [optional] | +|**deviceType** | **String** | Gets or sets the type of the device. | [optional] | +|**nowPlayingItem** | [**BaseItemDto**](BaseItemDto.md) | Gets or sets the now playing item. | [optional] | +|**nowViewingItem** | [**BaseItemDto**](BaseItemDto.md) | Gets or sets the now viewing item. | [optional] | +|**deviceId** | **String** | Gets or sets the device id. | [optional] | +|**applicationVersion** | **String** | Gets or sets the application version. | [optional] | +|**transcodingInfo** | [**TranscodingInfo**](TranscodingInfo.md) | Gets or sets the transcoding info. | [optional] | +|**isActive** | **Boolean** | Gets or sets a value indicating whether this session is active. | [optional] | +|**supportsMediaControl** | **Boolean** | Gets or sets a value indicating whether the session supports media control. | [optional] | +|**supportsRemoteControl** | **Boolean** | Gets or sets a value indicating whether the session supports remote control. | [optional] | +|**nowPlayingQueue** | [**List<QueueItem>**](QueueItem.md) | Gets or sets the now playing queue. | [optional] | +|**nowPlayingQueueFullItems** | [**List<BaseItemDto>**](BaseItemDto.md) | Gets or sets the now playing queue full items. | [optional] | +|**hasCustomDeviceName** | **Boolean** | Gets or sets a value indicating whether the session has a custom device name. | [optional] | +|**playlistItemId** | **String** | Gets or sets the playlist item id. | [optional] | +|**serverId** | **String** | Gets or sets the server id. | [optional] | +|**userPrimaryImageTag** | **String** | Gets or sets the user primary image tag. | [optional] | +|**supportedCommands** | **List<GeneralCommandType>** | Gets or sets the supported commands. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SessionMessageType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionMessageType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SessionMessageType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionMessageType.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SessionUserInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionUserInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SessionUserInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionUserInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionsMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionsMessage.md new file mode 100644 index 0000000000000..de7e242df89ff --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionsMessage.md @@ -0,0 +1,16 @@ + + +# SessionsMessage + +Sessions message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**List<SessionInfoDto>**](SessionInfoDto.md) | Gets or sets the data. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionsStartMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionsStartMessage.md new file mode 100644 index 0000000000000..237dbc28ae4d5 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionsStartMessage.md @@ -0,0 +1,15 @@ + + +# SessionsStartMessage + +Sessions start message. Data is the timing data encoded as \"$initialDelay,$interval\" in ms. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | **String** | Gets or sets the data. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionsStopMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionsStopMessage.md new file mode 100644 index 0000000000000..76b68ad42ac4a --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SessionsStopMessage.md @@ -0,0 +1,14 @@ + + +# SessionsStopMessage + +Sessions stop message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SetChannelMappingDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SetChannelMappingDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SetChannelMappingDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SetChannelMappingDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SetPlaylistItemRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SetPlaylistItemRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SetPlaylistItemRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SetPlaylistItemRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SetRepeatModeRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SetRepeatModeRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SetRepeatModeRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SetRepeatModeRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SetShuffleModeRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SetShuffleModeRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SetShuffleModeRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SetShuffleModeRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SongInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SongInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SongInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SongInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SortOrder.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SortOrder.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SortOrder.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SortOrder.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SpecialViewOptionDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SpecialViewOptionDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SpecialViewOptionDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SpecialViewOptionDto.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/StartupApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/StartupApi.md new file mode 100644 index 0000000000000..259a044f5754f --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/StartupApi.md @@ -0,0 +1,478 @@ +# StartupApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**completeWizard**](StartupApi.md#completeWizard) | **POST** /Startup/Complete | Completes the startup wizard. | +| [**getFirstUser**](StartupApi.md#getFirstUser) | **GET** /Startup/User | Gets the first user. | +| [**getFirstUser2**](StartupApi.md#getFirstUser2) | **GET** /Startup/FirstUser | Gets the first user. | +| [**getStartupConfiguration**](StartupApi.md#getStartupConfiguration) | **GET** /Startup/Configuration | Gets the initial startup wizard configuration. | +| [**setRemoteAccess**](StartupApi.md#setRemoteAccess) | **POST** /Startup/RemoteAccess | Sets remote access and UPnP. | +| [**updateInitialConfiguration**](StartupApi.md#updateInitialConfiguration) | **POST** /Startup/Configuration | Sets the initial startup wizard configuration. | +| [**updateStartupUser**](StartupApi.md#updateStartupUser) | **POST** /Startup/User | Sets the user name and password. | + + + +# **completeWizard** +> completeWizard() + +Completes the startup wizard. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.StartupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + StartupApi apiInstance = new StartupApi(defaultClient); + try { + apiInstance.completeWizard(); + } catch (ApiException e) { + System.err.println("Exception when calling StartupApi#completeWizard"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Startup wizard completed. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getFirstUser** +> StartupUserDto getFirstUser() + +Gets the first user. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.StartupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + StartupApi apiInstance = new StartupApi(defaultClient); + try { + StartupUserDto result = apiInstance.getFirstUser(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling StartupApi#getFirstUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**StartupUserDto**](StartupUserDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Initial user retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getFirstUser2** +> StartupUserDto getFirstUser2() + +Gets the first user. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.StartupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + StartupApi apiInstance = new StartupApi(defaultClient); + try { + StartupUserDto result = apiInstance.getFirstUser2(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling StartupApi#getFirstUser2"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**StartupUserDto**](StartupUserDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Initial user retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getStartupConfiguration** +> StartupConfigurationDto getStartupConfiguration() + +Gets the initial startup wizard configuration. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.StartupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + StartupApi apiInstance = new StartupApi(defaultClient); + try { + StartupConfigurationDto result = apiInstance.getStartupConfiguration(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling StartupApi#getStartupConfiguration"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**StartupConfigurationDto**](StartupConfigurationDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Initial startup wizard configuration retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **setRemoteAccess** +> setRemoteAccess(startupRemoteAccessDto) + +Sets remote access and UPnP. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.StartupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + StartupApi apiInstance = new StartupApi(defaultClient); + StartupRemoteAccessDto startupRemoteAccessDto = new StartupRemoteAccessDto(); // StartupRemoteAccessDto | The startup remote access dto. + try { + apiInstance.setRemoteAccess(startupRemoteAccessDto); + } catch (ApiException e) { + System.err.println("Exception when calling StartupApi#setRemoteAccess"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **startupRemoteAccessDto** | [**StartupRemoteAccessDto**](StartupRemoteAccessDto.md)| The startup remote access dto. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Configuration saved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateInitialConfiguration** +> updateInitialConfiguration(startupConfigurationDto) + +Sets the initial startup wizard configuration. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.StartupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + StartupApi apiInstance = new StartupApi(defaultClient); + StartupConfigurationDto startupConfigurationDto = new StartupConfigurationDto(); // StartupConfigurationDto | The updated startup configuration. + try { + apiInstance.updateInitialConfiguration(startupConfigurationDto); + } catch (ApiException e) { + System.err.println("Exception when calling StartupApi#updateInitialConfiguration"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **startupConfigurationDto** | [**StartupConfigurationDto**](StartupConfigurationDto.md)| The updated startup configuration. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Configuration saved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateStartupUser** +> updateStartupUser(startupUserDto) + +Sets the user name and password. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.StartupApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + StartupApi apiInstance = new StartupApi(defaultClient); + StartupUserDto startupUserDto = new StartupUserDto(); // StartupUserDto | The DTO containing username and password. + try { + apiInstance.updateStartupUser(startupUserDto); + } catch (ApiException e) { + System.err.println("Exception when calling StartupApi#updateStartupUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **startupUserDto** | [**StartupUserDto**](StartupUserDto.md)| The DTO containing username and password. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Updated user name and password. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/StartupConfigurationDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/StartupConfigurationDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/StartupConfigurationDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/StartupConfigurationDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/StartupRemoteAccessDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/StartupRemoteAccessDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/StartupRemoteAccessDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/StartupRemoteAccessDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/StartupUserDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/StartupUserDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/StartupUserDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/StartupUserDto.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/StringGroupUpdate.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/StringGroupUpdate.md new file mode 100644 index 0000000000000..dea4a3c5357f3 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/StringGroupUpdate.md @@ -0,0 +1,16 @@ + + +# StringGroupUpdate + +Class GroupUpdate. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**groupId** | **UUID** | Gets the group identifier. | [optional] [readonly] | +|**type** | **GroupUpdateType** | Gets the update type. | [optional] | +|**data** | **String** | Gets the update data. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/StudiosApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/StudiosApi.md new file mode 100644 index 0000000000000..0948b8bf22bb2 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/StudiosApi.md @@ -0,0 +1,182 @@ +# StudiosApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getStudio**](StudiosApi.md#getStudio) | **GET** /Studios/{name} | Gets a studio by name. | +| [**getStudios**](StudiosApi.md#getStudios) | **GET** /Studios | Gets all studios from a given item, folder, or the entire library. | + + + +# **getStudio** +> BaseItemDto getStudio(name, userId) + +Gets a studio by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.StudiosApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + StudiosApi apiInstance = new StudiosApi(defaultClient); + String name = "name_example"; // String | Studio name. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + try { + BaseItemDto result = apiInstance.getStudio(name, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling StudiosApi#getStudio"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| Studio name. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | + +### Return type + +[**BaseItemDto**](BaseItemDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Studio returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getStudios** +> BaseItemDtoQueryResult getStudios(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, enableUserData, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, enableImages, enableTotalRecordCount) + +Gets all studios from a given item, folder, or the entire library. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.StudiosApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + StudiosApi apiInstance = new StudiosApi(defaultClient); + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + String searchTerm = "searchTerm_example"; // String | Optional. Search term. + UUID parentId = UUID.randomUUID(); // UUID | Specify this to localize the search to a specific item or folder. Omit to use the root. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + List excludeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. + List includeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. + Boolean isFavorite = true; // Boolean | Optional filter by items that are marked as favorite, or not. + Boolean enableUserData = true; // Boolean | Optional, include user data. + Integer imageTypeLimit = 56; // Integer | Optional, the max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + UUID userId = UUID.randomUUID(); // UUID | User id. + String nameStartsWithOrGreater = "nameStartsWithOrGreater_example"; // String | Optional filter by items whose name is sorted equally or greater than a given input string. + String nameStartsWith = "nameStartsWith_example"; // String | Optional filter by items whose name is sorted equally than a given input string. + String nameLessThan = "nameLessThan_example"; // String | Optional filter by items whose name is equally or lesser than a given input string. + Boolean enableImages = true; // Boolean | Optional, include image information in output. + Boolean enableTotalRecordCount = true; // Boolean | Total record count. + try { + BaseItemDtoQueryResult result = apiInstance.getStudios(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, enableUserData, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, enableImages, enableTotalRecordCount); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling StudiosApi#getStudios"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **searchTerm** | **String**| Optional. Search term. | [optional] | +| **parentId** | **UUID**| Specify this to localize the search to a specific item or folder. Omit to use the root. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **excludeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. | [optional] | +| **includeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. | [optional] | +| **isFavorite** | **Boolean**| Optional filter by items that are marked as favorite, or not. | [optional] | +| **enableUserData** | **Boolean**| Optional, include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional, the max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **userId** | **UUID**| 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** | **Boolean**| Optional, include image information in output. | [optional] [default to true] | +| **enableTotalRecordCount** | **Boolean**| Total record count. | [optional] [default to true] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Studios returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SubtitleApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SubtitleApi.md new file mode 100644 index 0000000000000..a012923506d2d --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SubtitleApi.md @@ -0,0 +1,750 @@ +# SubtitleApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**deleteSubtitle**](SubtitleApi.md#deleteSubtitle) | **DELETE** /Videos/{itemId}/Subtitles/{index} | Deletes an external subtitle file. | +| [**downloadRemoteSubtitles**](SubtitleApi.md#downloadRemoteSubtitles) | **POST** /Items/{itemId}/RemoteSearch/Subtitles/{subtitleId} | Downloads a remote subtitle. | +| [**getFallbackFont**](SubtitleApi.md#getFallbackFont) | **GET** /FallbackFont/Fonts/{name} | Gets a fallback font file. | +| [**getFallbackFontList**](SubtitleApi.md#getFallbackFontList) | **GET** /FallbackFont/Fonts | Gets a list of available fallback font files. | +| [**getRemoteSubtitles**](SubtitleApi.md#getRemoteSubtitles) | **GET** /Providers/Subtitles/Subtitles/{subtitleId} | Gets the remote subtitles. | +| [**getSubtitle**](SubtitleApi.md#getSubtitle) | **GET** /Videos/{routeItemId}/{routeMediaSourceId}/Subtitles/{routeIndex}/Stream.{routeFormat} | Gets subtitles in a specified format. | +| [**getSubtitlePlaylist**](SubtitleApi.md#getSubtitlePlaylist) | **GET** /Videos/{itemId}/{mediaSourceId}/Subtitles/{index}/subtitles.m3u8 | Gets an HLS subtitle playlist. | +| [**getSubtitleWithTicks**](SubtitleApi.md#getSubtitleWithTicks) | **GET** /Videos/{routeItemId}/{routeMediaSourceId}/Subtitles/{routeIndex}/{routeStartPositionTicks}/Stream.{routeFormat} | Gets subtitles in a specified format. | +| [**searchRemoteSubtitles**](SubtitleApi.md#searchRemoteSubtitles) | **GET** /Items/{itemId}/RemoteSearch/Subtitles/{language} | Search remote subtitles. | +| [**uploadSubtitle**](SubtitleApi.md#uploadSubtitle) | **POST** /Videos/{itemId}/Subtitles | Upload an external subtitle file. | + + + +# **deleteSubtitle** +> deleteSubtitle(itemId, index) + +Deletes an external subtitle file. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SubtitleApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SubtitleApi apiInstance = new SubtitleApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + Integer index = 56; // Integer | The index of the subtitle file. + try { + apiInstance.deleteSubtitle(itemId, index); + } catch (ApiException e) { + System.err.println("Exception when calling SubtitleApi#deleteSubtitle"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **index** | **Integer**| The index of the subtitle file. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Subtitle deleted. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **downloadRemoteSubtitles** +> downloadRemoteSubtitles(itemId, subtitleId) + +Downloads a remote subtitle. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SubtitleApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SubtitleApi apiInstance = new SubtitleApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String subtitleId = "subtitleId_example"; // String | The subtitle id. + try { + apiInstance.downloadRemoteSubtitles(itemId, subtitleId); + } catch (ApiException e) { + System.err.println("Exception when calling SubtitleApi#downloadRemoteSubtitles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **subtitleId** | **String**| The subtitle id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Subtitle downloaded. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getFallbackFont** +> File getFallbackFont(name) + +Gets a fallback font file. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SubtitleApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SubtitleApi apiInstance = new SubtitleApi(defaultClient); + String name = "name_example"; // String | The name of the fallback font file to get. + try { + File result = apiInstance.getFallbackFont(name); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SubtitleApi#getFallbackFont"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| The name of the fallback font file to get. | | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: font/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Fallback font file retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getFallbackFontList** +> List<FontFile> getFallbackFontList() + +Gets a list of available fallback font files. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SubtitleApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SubtitleApi apiInstance = new SubtitleApi(defaultClient); + try { + List result = apiInstance.getFallbackFontList(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SubtitleApi#getFallbackFontList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<FontFile>**](FontFile.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Information retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getRemoteSubtitles** +> File getRemoteSubtitles(subtitleId) + +Gets the remote subtitles. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SubtitleApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SubtitleApi apiInstance = new SubtitleApi(defaultClient); + String subtitleId = "subtitleId_example"; // String | The item id. + try { + File result = apiInstance.getRemoteSubtitles(subtitleId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SubtitleApi#getRemoteSubtitles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **subtitleId** | **String**| The item id. | | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | File returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getSubtitle** +> File getSubtitle(routeItemId, routeMediaSourceId, routeIndex, routeFormat, itemId, mediaSourceId, index, format, endPositionTicks, copyTimestamps, addVttTimeMap, startPositionTicks) + +Gets subtitles in a specified format. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SubtitleApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + SubtitleApi apiInstance = new SubtitleApi(defaultClient); + UUID routeItemId = UUID.randomUUID(); // UUID | The (route) item id. + String routeMediaSourceId = "routeMediaSourceId_example"; // String | The (route) media source id. + Integer routeIndex = 56; // Integer | The (route) subtitle stream index. + String routeFormat = "routeFormat_example"; // String | The (route) format of the returned subtitle. + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String mediaSourceId = "mediaSourceId_example"; // String | The media source id. + Integer index = 56; // Integer | The subtitle stream index. + String format = "format_example"; // String | The format of the returned subtitle. + Long endPositionTicks = 56L; // Long | Optional. The end position of the subtitle in ticks. + Boolean copyTimestamps = false; // Boolean | Optional. Whether to copy the timestamps. + Boolean addVttTimeMap = false; // Boolean | Optional. Whether to add a VTT time map. + Long startPositionTicks = 0L; // Long | The start position of the subtitle in ticks. + try { + File result = apiInstance.getSubtitle(routeItemId, routeMediaSourceId, routeIndex, routeFormat, itemId, mediaSourceId, index, format, endPositionTicks, copyTimestamps, addVttTimeMap, startPositionTicks); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SubtitleApi#getSubtitle"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **routeItemId** | **UUID**| The (route) item id. | | +| **routeMediaSourceId** | **String**| The (route) media source id. | | +| **routeIndex** | **Integer**| The (route) subtitle stream index. | | +| **routeFormat** | **String**| The (route) format of the returned subtitle. | | +| **itemId** | **UUID**| The item id. | [optional] | +| **mediaSourceId** | **String**| The media source id. | [optional] | +| **index** | **Integer**| The subtitle stream index. | [optional] | +| **format** | **String**| The format of the returned subtitle. | [optional] | +| **endPositionTicks** | **Long**| Optional. The end position of the subtitle in ticks. | [optional] | +| **copyTimestamps** | **Boolean**| Optional. Whether to copy the timestamps. | [optional] [default to false] | +| **addVttTimeMap** | **Boolean**| Optional. Whether to add a VTT time map. | [optional] [default to false] | +| **startPositionTicks** | **Long**| The start position of the subtitle in ticks. | [optional] [default to 0] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | File returned. | - | + + +# **getSubtitlePlaylist** +> File getSubtitlePlaylist(itemId, index, mediaSourceId, segmentLength) + +Gets an HLS subtitle playlist. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SubtitleApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SubtitleApi apiInstance = new SubtitleApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + Integer index = 56; // Integer | The subtitle stream index. + String mediaSourceId = "mediaSourceId_example"; // String | The media source id. + Integer segmentLength = 56; // Integer | The subtitle segment length. + try { + File result = apiInstance.getSubtitlePlaylist(itemId, index, mediaSourceId, segmentLength); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SubtitleApi#getSubtitlePlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **index** | **Integer**| The subtitle stream index. | | +| **mediaSourceId** | **String**| The media source id. | | +| **segmentLength** | **Integer**| The subtitle segment length. | | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/x-mpegURL, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Subtitle playlist retrieved. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getSubtitleWithTicks** +> File getSubtitleWithTicks(routeItemId, routeMediaSourceId, routeIndex, routeStartPositionTicks, routeFormat, itemId, mediaSourceId, index, startPositionTicks, format, endPositionTicks, copyTimestamps, addVttTimeMap) + +Gets subtitles in a specified format. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SubtitleApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + SubtitleApi apiInstance = new SubtitleApi(defaultClient); + UUID routeItemId = UUID.randomUUID(); // UUID | The (route) item id. + String routeMediaSourceId = "routeMediaSourceId_example"; // String | The (route) media source id. + Integer routeIndex = 56; // Integer | The (route) subtitle stream index. + Long routeStartPositionTicks = 56L; // Long | The (route) start position of the subtitle in ticks. + String routeFormat = "routeFormat_example"; // String | The (route) format of the returned subtitle. + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String mediaSourceId = "mediaSourceId_example"; // String | The media source id. + Integer index = 56; // Integer | The subtitle stream index. + Long startPositionTicks = 56L; // Long | The start position of the subtitle in ticks. + String format = "format_example"; // String | The format of the returned subtitle. + Long endPositionTicks = 56L; // Long | Optional. The end position of the subtitle in ticks. + Boolean copyTimestamps = false; // Boolean | Optional. Whether to copy the timestamps. + Boolean addVttTimeMap = false; // Boolean | Optional. Whether to add a VTT time map. + try { + File result = apiInstance.getSubtitleWithTicks(routeItemId, routeMediaSourceId, routeIndex, routeStartPositionTicks, routeFormat, itemId, mediaSourceId, index, startPositionTicks, format, endPositionTicks, copyTimestamps, addVttTimeMap); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SubtitleApi#getSubtitleWithTicks"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **routeItemId** | **UUID**| The (route) item id. | | +| **routeMediaSourceId** | **String**| The (route) media source id. | | +| **routeIndex** | **Integer**| The (route) subtitle stream index. | | +| **routeStartPositionTicks** | **Long**| The (route) start position of the subtitle in ticks. | | +| **routeFormat** | **String**| The (route) format of the returned subtitle. | | +| **itemId** | **UUID**| The item id. | [optional] | +| **mediaSourceId** | **String**| The media source id. | [optional] | +| **index** | **Integer**| The subtitle stream index. | [optional] | +| **startPositionTicks** | **Long**| The start position of the subtitle in ticks. | [optional] | +| **format** | **String**| The format of the returned subtitle. | [optional] | +| **endPositionTicks** | **Long**| Optional. The end position of the subtitle in ticks. | [optional] | +| **copyTimestamps** | **Boolean**| Optional. Whether to copy the timestamps. | [optional] [default to false] | +| **addVttTimeMap** | **Boolean**| Optional. Whether to add a VTT time map. | [optional] [default to false] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | File returned. | - | + + +# **searchRemoteSubtitles** +> List<RemoteSubtitleInfo> searchRemoteSubtitles(itemId, language, isPerfectMatch) + +Search remote subtitles. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SubtitleApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SubtitleApi apiInstance = new SubtitleApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String language = "language_example"; // String | The language of the subtitles. + Boolean isPerfectMatch = true; // Boolean | Optional. Only show subtitles which are a perfect match. + try { + List result = apiInstance.searchRemoteSubtitles(itemId, language, isPerfectMatch); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SubtitleApi#searchRemoteSubtitles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **language** | **String**| The language of the subtitles. | | +| **isPerfectMatch** | **Boolean**| Optional. Only show subtitles which are a perfect match. | [optional] | + +### Return type + +[**List<RemoteSubtitleInfo>**](RemoteSubtitleInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Subtitles retrieved. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **uploadSubtitle** +> uploadSubtitle(itemId, uploadSubtitleDto) + +Upload an external subtitle file. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SubtitleApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SubtitleApi apiInstance = new SubtitleApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item the subtitle belongs to. + UploadSubtitleDto uploadSubtitleDto = new UploadSubtitleDto(); // UploadSubtitleDto | The request body. + try { + apiInstance.uploadSubtitle(itemId, uploadSubtitleDto); + } catch (ApiException e) { + System.err.println("Exception when calling SubtitleApi#uploadSubtitle"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item the subtitle belongs to. | | +| **uploadSubtitleDto** | [**UploadSubtitleDto**](UploadSubtitleDto.md)| The request body. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Subtitle uploaded. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SubtitleDeliveryMethod.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SubtitleDeliveryMethod.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SubtitleDeliveryMethod.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SubtitleDeliveryMethod.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SubtitleOptions.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SubtitleOptions.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SubtitleOptions.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SubtitleOptions.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SubtitlePlaybackMode.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SubtitlePlaybackMode.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SubtitlePlaybackMode.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SubtitlePlaybackMode.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SubtitleProfile.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SubtitleProfile.md new file mode 100644 index 0000000000000..4a3e43769cd63 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SubtitleProfile.md @@ -0,0 +1,18 @@ + + +# SubtitleProfile + +A class for subtitle profile information. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**format** | **String** | Gets or sets the format. | [optional] | +|**method** | **SubtitleDeliveryMethod** | Gets or sets the delivery method. | [optional] | +|**didlMode** | **String** | Gets or sets the DIDL mode. | [optional] | +|**language** | **String** | Gets or sets the language. | [optional] | +|**container** | **String** | Gets or sets the container. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SuggestionsApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SuggestionsApi.md new file mode 100644 index 0000000000000..d01e97f86f736 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SuggestionsApi.md @@ -0,0 +1,88 @@ +# SuggestionsApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getSuggestions**](SuggestionsApi.md#getSuggestions) | **GET** /Items/Suggestions | Gets suggestions. | + + + +# **getSuggestions** +> BaseItemDtoQueryResult getSuggestions(userId, mediaType, type, startIndex, limit, enableTotalRecordCount) + +Gets suggestions. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SuggestionsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SuggestionsApi apiInstance = new SuggestionsApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | The user id. + List mediaType = Arrays.asList(); // List | The media types. + List type = Arrays.asList(); // List | The type. + Integer startIndex = 56; // Integer | Optional. The start index. + Integer limit = 56; // Integer | Optional. The limit. + Boolean enableTotalRecordCount = false; // Boolean | Whether to enable the total record count. + try { + BaseItemDtoQueryResult result = apiInstance.getSuggestions(userId, mediaType, type, startIndex, limit, enableTotalRecordCount); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SuggestionsApi#getSuggestions"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| The user id. | [optional] | +| **mediaType** | [**List<MediaType>**](MediaType.md)| The media types. | [optional] | +| **type** | [**List<BaseItemKind>**](BaseItemKind.md)| The type. | [optional] | +| **startIndex** | **Integer**| Optional. The start index. | [optional] | +| **limit** | **Integer**| Optional. The limit. | [optional] | +| **enableTotalRecordCount** | **Boolean**| Whether to enable the total record count. | [optional] [default to false] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Suggestions returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SyncPlayApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SyncPlayApi.md new file mode 100644 index 0000000000000..d5049ab1aa2ca --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SyncPlayApi.md @@ -0,0 +1,1438 @@ +# SyncPlayApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**syncPlayBuffering**](SyncPlayApi.md#syncPlayBuffering) | **POST** /SyncPlay/Buffering | Notify SyncPlay group that member is buffering. | +| [**syncPlayCreateGroup**](SyncPlayApi.md#syncPlayCreateGroup) | **POST** /SyncPlay/New | Create a new SyncPlay group. | +| [**syncPlayGetGroups**](SyncPlayApi.md#syncPlayGetGroups) | **GET** /SyncPlay/List | Gets all SyncPlay groups. | +| [**syncPlayJoinGroup**](SyncPlayApi.md#syncPlayJoinGroup) | **POST** /SyncPlay/Join | Join an existing SyncPlay group. | +| [**syncPlayLeaveGroup**](SyncPlayApi.md#syncPlayLeaveGroup) | **POST** /SyncPlay/Leave | Leave the joined SyncPlay group. | +| [**syncPlayMovePlaylistItem**](SyncPlayApi.md#syncPlayMovePlaylistItem) | **POST** /SyncPlay/MovePlaylistItem | Request to move an item in the playlist in SyncPlay group. | +| [**syncPlayNextItem**](SyncPlayApi.md#syncPlayNextItem) | **POST** /SyncPlay/NextItem | Request next item in SyncPlay group. | +| [**syncPlayPause**](SyncPlayApi.md#syncPlayPause) | **POST** /SyncPlay/Pause | Request pause in SyncPlay group. | +| [**syncPlayPing**](SyncPlayApi.md#syncPlayPing) | **POST** /SyncPlay/Ping | Update session ping. | +| [**syncPlayPreviousItem**](SyncPlayApi.md#syncPlayPreviousItem) | **POST** /SyncPlay/PreviousItem | Request previous item in SyncPlay group. | +| [**syncPlayQueue**](SyncPlayApi.md#syncPlayQueue) | **POST** /SyncPlay/Queue | Request to queue items to the playlist of a SyncPlay group. | +| [**syncPlayReady**](SyncPlayApi.md#syncPlayReady) | **POST** /SyncPlay/Ready | Notify SyncPlay group that member is ready for playback. | +| [**syncPlayRemoveFromPlaylist**](SyncPlayApi.md#syncPlayRemoveFromPlaylist) | **POST** /SyncPlay/RemoveFromPlaylist | Request to remove items from the playlist in SyncPlay group. | +| [**syncPlaySeek**](SyncPlayApi.md#syncPlaySeek) | **POST** /SyncPlay/Seek | Request seek in SyncPlay group. | +| [**syncPlaySetIgnoreWait**](SyncPlayApi.md#syncPlaySetIgnoreWait) | **POST** /SyncPlay/SetIgnoreWait | Request SyncPlay group to ignore member during group-wait. | +| [**syncPlaySetNewQueue**](SyncPlayApi.md#syncPlaySetNewQueue) | **POST** /SyncPlay/SetNewQueue | Request to set new playlist in SyncPlay group. | +| [**syncPlaySetPlaylistItem**](SyncPlayApi.md#syncPlaySetPlaylistItem) | **POST** /SyncPlay/SetPlaylistItem | Request to change playlist item in SyncPlay group. | +| [**syncPlaySetRepeatMode**](SyncPlayApi.md#syncPlaySetRepeatMode) | **POST** /SyncPlay/SetRepeatMode | Request to set repeat mode in SyncPlay group. | +| [**syncPlaySetShuffleMode**](SyncPlayApi.md#syncPlaySetShuffleMode) | **POST** /SyncPlay/SetShuffleMode | Request to set shuffle mode in SyncPlay group. | +| [**syncPlayStop**](SyncPlayApi.md#syncPlayStop) | **POST** /SyncPlay/Stop | Request stop in SyncPlay group. | +| [**syncPlayUnpause**](SyncPlayApi.md#syncPlayUnpause) | **POST** /SyncPlay/Unpause | Request unpause in SyncPlay group. | + + + +# **syncPlayBuffering** +> syncPlayBuffering(bufferRequestDto) + +Notify SyncPlay group that member is buffering. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + BufferRequestDto bufferRequestDto = new BufferRequestDto(); // BufferRequestDto | The player status. + try { + apiInstance.syncPlayBuffering(bufferRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlayBuffering"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **bufferRequestDto** | [**BufferRequestDto**](BufferRequestDto.md)| The player status. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Group state update sent to all group members. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlayCreateGroup** +> syncPlayCreateGroup(newGroupRequestDto) + +Create a new SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + NewGroupRequestDto newGroupRequestDto = new NewGroupRequestDto(); // NewGroupRequestDto | The settings of the new group. + try { + apiInstance.syncPlayCreateGroup(newGroupRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlayCreateGroup"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **newGroupRequestDto** | [**NewGroupRequestDto**](NewGroupRequestDto.md)| The settings of the new group. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | New group created. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlayGetGroups** +> List<GroupInfoDto> syncPlayGetGroups() + +Gets all SyncPlay groups. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + try { + List result = apiInstance.syncPlayGetGroups(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlayGetGroups"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<GroupInfoDto>**](GroupInfoDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Groups returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlayJoinGroup** +> syncPlayJoinGroup(joinGroupRequestDto) + +Join an existing SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + JoinGroupRequestDto joinGroupRequestDto = new JoinGroupRequestDto(); // JoinGroupRequestDto | The group to join. + try { + apiInstance.syncPlayJoinGroup(joinGroupRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlayJoinGroup"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **joinGroupRequestDto** | [**JoinGroupRequestDto**](JoinGroupRequestDto.md)| The group to join. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Group join successful. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlayLeaveGroup** +> syncPlayLeaveGroup() + +Leave the joined SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + try { + apiInstance.syncPlayLeaveGroup(); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlayLeaveGroup"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Group leave successful. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlayMovePlaylistItem** +> syncPlayMovePlaylistItem(movePlaylistItemRequestDto) + +Request to move an item in the playlist in SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + MovePlaylistItemRequestDto movePlaylistItemRequestDto = new MovePlaylistItemRequestDto(); // MovePlaylistItemRequestDto | The new position for the item. + try { + apiInstance.syncPlayMovePlaylistItem(movePlaylistItemRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlayMovePlaylistItem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **movePlaylistItemRequestDto** | [**MovePlaylistItemRequestDto**](MovePlaylistItemRequestDto.md)| The new position for the item. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Queue update sent to all group members. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlayNextItem** +> syncPlayNextItem(nextItemRequestDto) + +Request next item in SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + NextItemRequestDto nextItemRequestDto = new NextItemRequestDto(); // NextItemRequestDto | The current item information. + try { + apiInstance.syncPlayNextItem(nextItemRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlayNextItem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **nextItemRequestDto** | [**NextItemRequestDto**](NextItemRequestDto.md)| The current item information. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Next item update sent to all group members. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlayPause** +> syncPlayPause() + +Request pause in SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + try { + apiInstance.syncPlayPause(); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlayPause"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Pause update sent to all group members. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlayPing** +> syncPlayPing(pingRequestDto) + +Update session ping. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + PingRequestDto pingRequestDto = new PingRequestDto(); // PingRequestDto | The new ping. + try { + apiInstance.syncPlayPing(pingRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlayPing"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **pingRequestDto** | [**PingRequestDto**](PingRequestDto.md)| The new ping. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Ping updated. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlayPreviousItem** +> syncPlayPreviousItem(previousItemRequestDto) + +Request previous item in SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + PreviousItemRequestDto previousItemRequestDto = new PreviousItemRequestDto(); // PreviousItemRequestDto | The current item information. + try { + apiInstance.syncPlayPreviousItem(previousItemRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlayPreviousItem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **previousItemRequestDto** | [**PreviousItemRequestDto**](PreviousItemRequestDto.md)| The current item information. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Previous item update sent to all group members. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlayQueue** +> syncPlayQueue(queueRequestDto) + +Request to queue items to the playlist of a SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + QueueRequestDto queueRequestDto = new QueueRequestDto(); // QueueRequestDto | The items to add. + try { + apiInstance.syncPlayQueue(queueRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlayQueue"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **queueRequestDto** | [**QueueRequestDto**](QueueRequestDto.md)| The items to add. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Queue update sent to all group members. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlayReady** +> syncPlayReady(readyRequestDto) + +Notify SyncPlay group that member is ready for playback. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + ReadyRequestDto readyRequestDto = new ReadyRequestDto(); // ReadyRequestDto | The player status. + try { + apiInstance.syncPlayReady(readyRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlayReady"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **readyRequestDto** | [**ReadyRequestDto**](ReadyRequestDto.md)| The player status. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Group state update sent to all group members. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlayRemoveFromPlaylist** +> syncPlayRemoveFromPlaylist(removeFromPlaylistRequestDto) + +Request to remove items from the playlist in SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + RemoveFromPlaylistRequestDto removeFromPlaylistRequestDto = new RemoveFromPlaylistRequestDto(); // RemoveFromPlaylistRequestDto | The items to remove. + try { + apiInstance.syncPlayRemoveFromPlaylist(removeFromPlaylistRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlayRemoveFromPlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **removeFromPlaylistRequestDto** | [**RemoveFromPlaylistRequestDto**](RemoveFromPlaylistRequestDto.md)| The items to remove. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Queue update sent to all group members. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlaySeek** +> syncPlaySeek(seekRequestDto) + +Request seek in SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + SeekRequestDto seekRequestDto = new SeekRequestDto(); // SeekRequestDto | The new playback position. + try { + apiInstance.syncPlaySeek(seekRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlaySeek"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **seekRequestDto** | [**SeekRequestDto**](SeekRequestDto.md)| The new playback position. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Seek update sent to all group members. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlaySetIgnoreWait** +> syncPlaySetIgnoreWait(ignoreWaitRequestDto) + +Request SyncPlay group to ignore member during group-wait. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + IgnoreWaitRequestDto ignoreWaitRequestDto = new IgnoreWaitRequestDto(); // IgnoreWaitRequestDto | The settings to set. + try { + apiInstance.syncPlaySetIgnoreWait(ignoreWaitRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlaySetIgnoreWait"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **ignoreWaitRequestDto** | [**IgnoreWaitRequestDto**](IgnoreWaitRequestDto.md)| The settings to set. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Member state updated. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlaySetNewQueue** +> syncPlaySetNewQueue(playRequestDto) + +Request to set new playlist in SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + PlayRequestDto playRequestDto = new PlayRequestDto(); // PlayRequestDto | The new playlist to play in the group. + try { + apiInstance.syncPlaySetNewQueue(playRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlaySetNewQueue"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **playRequestDto** | [**PlayRequestDto**](PlayRequestDto.md)| The new playlist to play in the group. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Queue update sent to all group members. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlaySetPlaylistItem** +> syncPlaySetPlaylistItem(setPlaylistItemRequestDto) + +Request to change playlist item in SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + SetPlaylistItemRequestDto setPlaylistItemRequestDto = new SetPlaylistItemRequestDto(); // SetPlaylistItemRequestDto | The new item to play. + try { + apiInstance.syncPlaySetPlaylistItem(setPlaylistItemRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlaySetPlaylistItem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **setPlaylistItemRequestDto** | [**SetPlaylistItemRequestDto**](SetPlaylistItemRequestDto.md)| The new item to play. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Queue update sent to all group members. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlaySetRepeatMode** +> syncPlaySetRepeatMode(setRepeatModeRequestDto) + +Request to set repeat mode in SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + SetRepeatModeRequestDto setRepeatModeRequestDto = new SetRepeatModeRequestDto(); // SetRepeatModeRequestDto | The new repeat mode. + try { + apiInstance.syncPlaySetRepeatMode(setRepeatModeRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlaySetRepeatMode"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **setRepeatModeRequestDto** | [**SetRepeatModeRequestDto**](SetRepeatModeRequestDto.md)| The new repeat mode. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Play queue update sent to all group members. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlaySetShuffleMode** +> syncPlaySetShuffleMode(setShuffleModeRequestDto) + +Request to set shuffle mode in SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + SetShuffleModeRequestDto setShuffleModeRequestDto = new SetShuffleModeRequestDto(); // SetShuffleModeRequestDto | The new shuffle mode. + try { + apiInstance.syncPlaySetShuffleMode(setShuffleModeRequestDto); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlaySetShuffleMode"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **setShuffleModeRequestDto** | [**SetShuffleModeRequestDto**](SetShuffleModeRequestDto.md)| The new shuffle mode. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Play queue update sent to all group members. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlayStop** +> syncPlayStop() + +Request stop in SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + try { + apiInstance.syncPlayStop(); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlayStop"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Stop update sent to all group members. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **syncPlayUnpause** +> syncPlayUnpause() + +Request unpause in SyncPlay group. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SyncPlayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SyncPlayApi apiInstance = new SyncPlayApi(defaultClient); + try { + apiInstance.syncPlayUnpause(); + } catch (ApiException e) { + System.err.println("Exception when calling SyncPlayApi#syncPlayUnpause"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Unpause update sent to all group members. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SyncPlayCommandMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SyncPlayCommandMessage.md new file mode 100644 index 0000000000000..2512131922e12 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SyncPlayCommandMessage.md @@ -0,0 +1,16 @@ + + +# SyncPlayCommandMessage + +Sync play command. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**SendCommand**](SendCommand.md) | Class SendCommand. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SyncPlayGroupUpdateCommandMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SyncPlayGroupUpdateCommandMessage.md new file mode 100644 index 0000000000000..e1659cb412b8f --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SyncPlayGroupUpdateCommandMessage.md @@ -0,0 +1,16 @@ + + +# SyncPlayGroupUpdateCommandMessage + +Untyped sync play command. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**GroupUpdate**](GroupUpdate.md) | Group update without data. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SyncPlayQueueItem.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SyncPlayQueueItem.md new file mode 100644 index 0000000000000..3e12418cb7807 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SyncPlayQueueItem.md @@ -0,0 +1,15 @@ + + +# SyncPlayQueueItem + +Class QueueItem. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**itemId** | **UUID** | Gets the item identifier. | [optional] | +|**playlistItemId** | **UUID** | Gets the playlist identifier of the item. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SyncPlayUserAccessType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SyncPlayUserAccessType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/SyncPlayUserAccessType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SyncPlayUserAccessType.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SystemApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SystemApi.md new file mode 100644 index 0000000000000..1e689570f3c0b --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SystemApi.md @@ -0,0 +1,644 @@ +# SystemApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getEndpointInfo**](SystemApi.md#getEndpointInfo) | **GET** /System/Endpoint | Gets information about the request endpoint. | +| [**getLogFile**](SystemApi.md#getLogFile) | **GET** /System/Logs/Log | Gets a log file. | +| [**getPingSystem**](SystemApi.md#getPingSystem) | **GET** /System/Ping | Pings the system. | +| [**getPublicSystemInfo**](SystemApi.md#getPublicSystemInfo) | **GET** /System/Info/Public | Gets public information about the server. | +| [**getServerLogs**](SystemApi.md#getServerLogs) | **GET** /System/Logs | Gets a list of available server log files. | +| [**getSystemInfo**](SystemApi.md#getSystemInfo) | **GET** /System/Info | Gets information about the server. | +| [**getWakeOnLanInfo**](SystemApi.md#getWakeOnLanInfo) | **GET** /System/WakeOnLanInfo | Gets wake on lan information. | +| [**postPingSystem**](SystemApi.md#postPingSystem) | **POST** /System/Ping | Pings the system. | +| [**restartApplication**](SystemApi.md#restartApplication) | **POST** /System/Restart | Restarts the application. | +| [**shutdownApplication**](SystemApi.md#shutdownApplication) | **POST** /System/Shutdown | Shuts down the application. | + + + +# **getEndpointInfo** +> EndPointInfo getEndpointInfo() + +Gets information about the request endpoint. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SystemApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SystemApi apiInstance = new SystemApi(defaultClient); + try { + EndPointInfo result = apiInstance.getEndpointInfo(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SystemApi#getEndpointInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**EndPointInfo**](EndPointInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Information retrieved. | - | +| **403** | User does not have permission to get endpoint information. | - | +| **401** | Unauthorized | - | + + +# **getLogFile** +> File getLogFile(name) + +Gets a log file. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SystemApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SystemApi apiInstance = new SystemApi(defaultClient); + String name = "name_example"; // String | The name of the log file to get. + try { + File result = apiInstance.getLogFile(name); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SystemApi#getLogFile"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| The name of the log file to get. | | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Log file retrieved. | - | +| **403** | User does not have permission to get log files. | - | +| **404** | Could not find a log file with the name. | - | +| **401** | Unauthorized | - | + + +# **getPingSystem** +> String getPingSystem() + +Pings the system. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SystemApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + SystemApi apiInstance = new SystemApi(defaultClient); + try { + String result = apiInstance.getPingSystem(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SystemApi#getPingSystem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Information retrieved. | - | + + +# **getPublicSystemInfo** +> PublicSystemInfo getPublicSystemInfo() + +Gets public information about the server. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SystemApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + SystemApi apiInstance = new SystemApi(defaultClient); + try { + PublicSystemInfo result = apiInstance.getPublicSystemInfo(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SystemApi#getPublicSystemInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**PublicSystemInfo**](PublicSystemInfo.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Information retrieved. | - | + + +# **getServerLogs** +> List<LogFile> getServerLogs() + +Gets a list of available server log files. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SystemApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SystemApi apiInstance = new SystemApi(defaultClient); + try { + List result = apiInstance.getServerLogs(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SystemApi#getServerLogs"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<LogFile>**](LogFile.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Information retrieved. | - | +| **403** | User does not have permission to get server logs. | - | +| **401** | Unauthorized | - | + + +# **getSystemInfo** +> SystemInfo getSystemInfo() + +Gets information about the server. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SystemApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SystemApi apiInstance = new SystemApi(defaultClient); + try { + SystemInfo result = apiInstance.getSystemInfo(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SystemApi#getSystemInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**SystemInfo**](SystemInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Information retrieved. | - | +| **403** | User does not have permission to retrieve information. | - | +| **401** | Unauthorized | - | + + +# **getWakeOnLanInfo** +> List<WakeOnLanInfo> getWakeOnLanInfo() + +Gets wake on lan information. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SystemApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SystemApi apiInstance = new SystemApi(defaultClient); + try { + List result = apiInstance.getWakeOnLanInfo(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SystemApi#getWakeOnLanInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<WakeOnLanInfo>**](WakeOnLanInfo.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Information retrieved. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **postPingSystem** +> String postPingSystem() + +Pings the system. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SystemApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + SystemApi apiInstance = new SystemApi(defaultClient); + try { + String result = apiInstance.postPingSystem(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SystemApi#postPingSystem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Information retrieved. | - | + + +# **restartApplication** +> restartApplication() + +Restarts the application. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SystemApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SystemApi apiInstance = new SystemApi(defaultClient); + try { + apiInstance.restartApplication(); + } catch (ApiException e) { + System.err.println("Exception when calling SystemApi#restartApplication"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Server restarted. | - | +| **403** | User does not have permission to restart server. | - | +| **401** | Unauthorized | - | + + +# **shutdownApplication** +> shutdownApplication() + +Shuts down the application. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.SystemApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + SystemApi apiInstance = new SystemApi(defaultClient); + try { + apiInstance.shutdownApplication(); + } catch (ApiException e) { + System.err.println("Exception when calling SystemApi#shutdownApplication"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Server shut down. | - | +| **403** | User does not have permission to shutdown server. | - | +| **401** | Unauthorized | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/SystemInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SystemInfo.md similarity index 89% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/SystemInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SystemInfo.md index e91f68ff39dc4..e46f650b27177 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/SystemInfo.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/SystemInfo.md @@ -31,9 +31,10 @@ Class SystemInfo. |**logPath** | **String** | Gets or sets the log path. | [optional] | |**internalMetadataPath** | **String** | Gets or sets the internal metadata path. | [optional] | |**transcodingTempPath** | **String** | Gets or sets the transcode path. | [optional] | +|**castReceiverApplications** | [**List<CastReceiverApplication>**](CastReceiverApplication.md) | Gets or sets the list of cast receiver applications. | [optional] | |**hasUpdateAvailable** | **Boolean** | Gets or sets a value indicating whether this instance has update available. | [optional] | -|**encoderLocation** | **FFmpegLocation** | Enum describing the location of the FFmpeg tool. | [optional] | -|**systemArchitecture** | **Architecture** | | [optional] | +|**encoderLocation** | **String** | | [optional] | +|**systemArchitecture** | **String** | | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TaskCompletionStatus.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TaskCompletionStatus.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TaskCompletionStatus.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TaskCompletionStatus.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TaskInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TaskInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TaskInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TaskInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TaskResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TaskResult.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TaskResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TaskResult.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TaskState.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TaskState.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TaskState.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TaskState.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TaskTriggerInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TaskTriggerInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TaskTriggerInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TaskTriggerInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ThemeMediaResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ThemeMediaResult.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ThemeMediaResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ThemeMediaResult.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimeSyncApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimeSyncApi.md new file mode 100644 index 0000000000000..32320f124bfb0 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimeSyncApi.md @@ -0,0 +1,65 @@ +# TimeSyncApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getUtcTime**](TimeSyncApi.md#getUtcTime) | **GET** /GetUtcTime | Gets the current UTC time. | + + + +# **getUtcTime** +> UtcTimeResponse getUtcTime() + +Gets the current UTC time. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.TimeSyncApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + TimeSyncApi apiInstance = new TimeSyncApi(defaultClient); + try { + UtcTimeResponse result = apiInstance.getUtcTime(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TimeSyncApi#getUtcTime"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**UtcTimeResponse**](UtcTimeResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Time returned. | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimerCancelledMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimerCancelledMessage.md new file mode 100644 index 0000000000000..634dd3aac0fb4 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimerCancelledMessage.md @@ -0,0 +1,16 @@ + + +# TimerCancelledMessage + +Timer cancelled message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**TimerEventInfo**](TimerEventInfo.md) | Gets or sets the data. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimerCreatedMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimerCreatedMessage.md new file mode 100644 index 0000000000000..0615bb1debf78 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimerCreatedMessage.md @@ -0,0 +1,16 @@ + + +# TimerCreatedMessage + +Timer created message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**TimerEventInfo**](TimerEventInfo.md) | Gets or sets the data. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TimerEventInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimerEventInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TimerEventInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimerEventInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TimerInfoDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimerInfoDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TimerInfoDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimerInfoDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/TimerInfoDtoQueryResult.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimerInfoDtoQueryResult.md similarity index 95% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/TimerInfoDtoQueryResult.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimerInfoDtoQueryResult.md index 4de68495f1483..fa82bffdad0a1 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/TimerInfoDtoQueryResult.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TimerInfoDtoQueryResult.md @@ -2,6 +2,7 @@ # TimerInfoDtoQueryResult +Query result container. ## Properties diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TmdbApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TmdbApi.md new file mode 100644 index 0000000000000..6720a3ea1b85c --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TmdbApi.md @@ -0,0 +1,74 @@ +# TmdbApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**tmdbClientConfiguration**](TmdbApi.md#tmdbClientConfiguration) | **GET** /Tmdb/ClientConfiguration | Gets the TMDb image configuration options. | + + + +# **tmdbClientConfiguration** +> ConfigImageTypes tmdbClientConfiguration() + +Gets the TMDb image configuration options. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.TmdbApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + TmdbApi apiInstance = new TmdbApi(defaultClient); + try { + ConfigImageTypes result = apiInstance.tmdbClientConfiguration(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TmdbApi#tmdbClientConfiguration"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ConfigImageTypes**](ConfigImageTypes.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TonemappingAlgorithm.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TonemappingAlgorithm.md new file mode 100644 index 0000000000000..1adb36dde12cf --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TonemappingAlgorithm.md @@ -0,0 +1,25 @@ + + +# TonemappingAlgorithm + +## Enum + + +* `NONE` (value: `"none"`) + +* `CLIP` (value: `"clip"`) + +* `LINEAR` (value: `"linear"`) + +* `GAMMA` (value: `"gamma"`) + +* `REINHARD` (value: `"reinhard"`) + +* `HABLE` (value: `"hable"`) + +* `MOBIUS` (value: `"mobius"`) + +* `BT2390` (value: `"bt2390"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TonemappingMode.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TonemappingMode.md new file mode 100644 index 0000000000000..36f83d805ab53 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TonemappingMode.md @@ -0,0 +1,19 @@ + + +# TonemappingMode + +## Enum + + +* `AUTO` (value: `"auto"`) + +* `MAX` (value: `"max"`) + +* `RGB` (value: `"rgb"`) + +* `LUM` (value: `"lum"`) + +* `ITP` (value: `"itp"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TonemappingRange.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TonemappingRange.md new file mode 100644 index 0000000000000..8d7cad15c1b37 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TonemappingRange.md @@ -0,0 +1,15 @@ + + +# TonemappingRange + +## Enum + + +* `AUTO` (value: `"auto"`) + +* `TV` (value: `"tv"`) + +* `PC` (value: `"pc"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TrailerInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrailerInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TrailerInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrailerInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TrailerInfoRemoteSearchQuery.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrailerInfoRemoteSearchQuery.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TrailerInfoRemoteSearchQuery.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrailerInfoRemoteSearchQuery.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrailersApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrailersApi.md new file mode 100644 index 0000000000000..9c4d28cc66a5e --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrailersApi.md @@ -0,0 +1,244 @@ +# TrailersApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getTrailers**](TrailersApi.md#getTrailers) | **GET** /Trailers | Finds movies and trailers similar to a given trailer. | + + + +# **getTrailers** +> BaseItemDtoQueryResult getTrailers(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages) + +Finds movies and trailers similar to a given trailer. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.TrailersApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + TrailersApi apiInstance = new TrailersApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | The user id supplied as query parameter; this is required when not using an API key. + String maxOfficialRating = "maxOfficialRating_example"; // String | Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). + Boolean hasThemeSong = true; // Boolean | Optional filter by items with theme songs. + Boolean hasThemeVideo = true; // Boolean | Optional filter by items with theme videos. + Boolean hasSubtitles = true; // Boolean | Optional filter by items with subtitles. + Boolean hasSpecialFeature = true; // Boolean | Optional filter by items with special features. + Boolean hasTrailer = true; // Boolean | Optional filter by items with trailers. + UUID adjacentTo = UUID.randomUUID(); // UUID | Optional. Return items that are siblings of a supplied item. + Integer parentIndexNumber = 56; // Integer | Optional filter by parent index number. + Boolean hasParentalRating = true; // Boolean | Optional filter by items that have or do not have a parental rating. + Boolean isHd = true; // Boolean | Optional filter by items that are HD or not. + Boolean is4K = true; // Boolean | Optional filter by items that are 4K or not. + List locationTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited. + List excludeLocationTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited. + Boolean isMissing = true; // Boolean | Optional filter by items that are missing episodes or not. + Boolean isUnaired = true; // Boolean | Optional filter by items that are unaired episodes or not. + Double minCommunityRating = 3.4D; // Double | Optional filter by minimum community rating. + Double minCriticRating = 3.4D; // Double | Optional filter by minimum critic rating. + OffsetDateTime minPremiereDate = OffsetDateTime.now(); // OffsetDateTime | Optional. The minimum premiere date. Format = ISO. + OffsetDateTime minDateLastSaved = OffsetDateTime.now(); // OffsetDateTime | Optional. The minimum last saved date. Format = ISO. + OffsetDateTime minDateLastSavedForUser = OffsetDateTime.now(); // OffsetDateTime | Optional. The minimum last saved date for the current user. Format = ISO. + OffsetDateTime maxPremiereDate = OffsetDateTime.now(); // OffsetDateTime | Optional. The maximum premiere date. Format = ISO. + Boolean hasOverview = true; // Boolean | Optional filter by items that have an overview or not. + Boolean hasImdbId = true; // Boolean | Optional filter by items that have an IMDb id or not. + Boolean hasTmdbId = true; // Boolean | Optional filter by items that have a TMDb id or not. + Boolean hasTvdbId = true; // Boolean | Optional filter by items that have a TVDb id or not. + Boolean isMovie = true; // Boolean | Optional filter for live tv movies. + Boolean isSeries = true; // Boolean | Optional filter for live tv series. + Boolean isNews = true; // Boolean | Optional filter for live tv news. + Boolean isKids = true; // Boolean | Optional filter for live tv kids. + Boolean isSports = true; // Boolean | Optional filter for live tv sports. + List excludeItemIds = Arrays.asList(); // List | Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + Boolean recursive = true; // Boolean | When searching within folders, this determines whether or not the search will be recursive. true/false. + String searchTerm = "searchTerm_example"; // String | Optional. Filter based on a search term. + List sortOrder = Arrays.asList(); // List | Sort Order - Ascending, Descending. + UUID parentId = UUID.randomUUID(); // UUID | Specify this to localize the search to a specific item or folder. Omit to use the root. + List fields = Arrays.asList(); // List | 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. + List excludeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. + List filters = Arrays.asList(); // List | Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. + Boolean isFavorite = true; // Boolean | Optional filter by items that are marked as favorite, or not. + List mediaTypes = Arrays.asList(); // List | Optional filter by MediaType. Allows multiple, comma delimited. + List imageTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. + List sortBy = Arrays.asList(); // List | Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. + Boolean isPlayed = true; // Boolean | Optional filter by items that are played, or not. + List genres = Arrays.asList(); // List | Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. + List officialRatings = Arrays.asList(); // List | Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. + List tags = Arrays.asList(); // List | Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. + List years = Arrays.asList(); // List | Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. + Boolean enableUserData = true; // Boolean | Optional, include user data. + Integer imageTypeLimit = 56; // Integer | Optional, the max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + String person = "person_example"; // String | Optional. If specified, results will be filtered to include only those containing the specified person. + List personIds = Arrays.asList(); // List | Optional. If specified, results will be filtered to include only those containing the specified person id. + List personTypes = Arrays.asList(); // List | Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. + List studios = Arrays.asList(); // List | Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. + List artists = Arrays.asList(); // List | Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited. + List excludeArtistIds = Arrays.asList(); // List | Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited. + List artistIds = Arrays.asList(); // List | Optional. If specified, results will be filtered to include only those containing the specified artist id. + List albumArtistIds = Arrays.asList(); // List | Optional. If specified, results will be filtered to include only those containing the specified album artist id. + List contributingArtistIds = Arrays.asList(); // List | Optional. If specified, results will be filtered to include only those containing the specified contributing artist id. + List albums = Arrays.asList(); // List | Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited. + List albumIds = Arrays.asList(); // List | Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited. + List ids = Arrays.asList(); // List | Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited. + List videoTypes = Arrays.asList(); // List | Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited. + String minOfficialRating = "minOfficialRating_example"; // String | Optional filter by minimum official rating (PG, PG-13, TV-MA, etc). + Boolean isLocked = true; // Boolean | Optional filter by items that are locked. + Boolean isPlaceHolder = true; // Boolean | Optional filter by items that are placeholders. + Boolean hasOfficialRating = true; // Boolean | Optional filter by items that have official ratings. + Boolean collapseBoxSetItems = true; // Boolean | Whether or not to hide items behind their boxsets. + Integer minWidth = 56; // Integer | Optional. Filter by the minimum width of the item. + Integer minHeight = 56; // Integer | Optional. Filter by the minimum height of the item. + Integer maxWidth = 56; // Integer | Optional. Filter by the maximum width of the item. + Integer maxHeight = 56; // Integer | Optional. Filter by the maximum height of the item. + Boolean is3D = true; // Boolean | Optional filter by items that are 3D, or not. + List seriesStatus = Arrays.asList(); // List | Optional filter by Series Status. Allows multiple, comma delimited. + String nameStartsWithOrGreater = "nameStartsWithOrGreater_example"; // String | Optional filter by items whose name is sorted equally or greater than a given input string. + String nameStartsWith = "nameStartsWith_example"; // String | Optional filter by items whose name is sorted equally than a given input string. + String nameLessThan = "nameLessThan_example"; // String | Optional filter by items whose name is equally or lesser than a given input string. + List studioIds = Arrays.asList(); // List | Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. + List genreIds = Arrays.asList(); // List | Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. + Boolean enableTotalRecordCount = true; // Boolean | Optional. Enable the total record count. + Boolean enableImages = true; // Boolean | Optional, include image information in output. + try { + BaseItemDtoQueryResult result = apiInstance.getTrailers(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TrailersApi#getTrailers"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| The user id supplied as query parameter; this is required when not using an API key. | [optional] | +| **maxOfficialRating** | **String**| Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). | [optional] | +| **hasThemeSong** | **Boolean**| Optional filter by items with theme songs. | [optional] | +| **hasThemeVideo** | **Boolean**| Optional filter by items with theme videos. | [optional] | +| **hasSubtitles** | **Boolean**| Optional filter by items with subtitles. | [optional] | +| **hasSpecialFeature** | **Boolean**| Optional filter by items with special features. | [optional] | +| **hasTrailer** | **Boolean**| Optional filter by items with trailers. | [optional] | +| **adjacentTo** | **UUID**| Optional. Return items that are siblings of a supplied item. | [optional] | +| **parentIndexNumber** | **Integer**| Optional filter by parent index number. | [optional] | +| **hasParentalRating** | **Boolean**| Optional filter by items that have or do not have a parental rating. | [optional] | +| **isHd** | **Boolean**| Optional filter by items that are HD or not. | [optional] | +| **is4K** | **Boolean**| Optional filter by items that are 4K or not. | [optional] | +| **locationTypes** | [**List<LocationType>**](LocationType.md)| Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited. | [optional] | +| **excludeLocationTypes** | [**List<LocationType>**](LocationType.md)| Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited. | [optional] | +| **isMissing** | **Boolean**| Optional filter by items that are missing episodes or not. | [optional] | +| **isUnaired** | **Boolean**| Optional filter by items that are unaired episodes or not. | [optional] | +| **minCommunityRating** | **Double**| Optional filter by minimum community rating. | [optional] | +| **minCriticRating** | **Double**| Optional filter by minimum critic rating. | [optional] | +| **minPremiereDate** | **OffsetDateTime**| Optional. The minimum premiere date. Format = ISO. | [optional] | +| **minDateLastSaved** | **OffsetDateTime**| Optional. The minimum last saved date. Format = ISO. | [optional] | +| **minDateLastSavedForUser** | **OffsetDateTime**| Optional. The minimum last saved date for the current user. Format = ISO. | [optional] | +| **maxPremiereDate** | **OffsetDateTime**| Optional. The maximum premiere date. Format = ISO. | [optional] | +| **hasOverview** | **Boolean**| Optional filter by items that have an overview or not. | [optional] | +| **hasImdbId** | **Boolean**| Optional filter by items that have an IMDb id or not. | [optional] | +| **hasTmdbId** | **Boolean**| Optional filter by items that have a TMDb id or not. | [optional] | +| **hasTvdbId** | **Boolean**| Optional filter by items that have a TVDb id or not. | [optional] | +| **isMovie** | **Boolean**| Optional filter for live tv movies. | [optional] | +| **isSeries** | **Boolean**| Optional filter for live tv series. | [optional] | +| **isNews** | **Boolean**| Optional filter for live tv news. | [optional] | +| **isKids** | **Boolean**| Optional filter for live tv kids. | [optional] | +| **isSports** | **Boolean**| Optional filter for live tv sports. | [optional] | +| **excludeItemIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited. | [optional] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **recursive** | **Boolean**| When searching within folders, this determines whether or not the search will be recursive. true/false. | [optional] | +| **searchTerm** | **String**| Optional. Filter based on a search term. | [optional] | +| **sortOrder** | [**List<SortOrder>**](SortOrder.md)| Sort Order - Ascending, Descending. | [optional] | +| **parentId** | **UUID**| Specify this to localize the search to a specific item or folder. Omit to use the root. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| 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. | [optional] | +| **excludeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. | [optional] | +| **filters** | [**List<ItemFilter>**](ItemFilter.md)| Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. | [optional] | +| **isFavorite** | **Boolean**| Optional filter by items that are marked as favorite, or not. | [optional] | +| **mediaTypes** | [**List<MediaType>**](MediaType.md)| Optional filter by MediaType. Allows multiple, comma delimited. | [optional] | +| **imageTypes** | [**List<ImageType>**](ImageType.md)| Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. | [optional] | +| **sortBy** | [**List<ItemSortBy>**](ItemSortBy.md)| Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. | [optional] | +| **isPlayed** | **Boolean**| Optional filter by items that are played, or not. | [optional] | +| **genres** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. | [optional] | +| **officialRatings** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. | [optional] | +| **tags** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. | [optional] | +| **years** | [**List<Integer>**](Integer.md)| Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. | [optional] | +| **enableUserData** | **Boolean**| Optional, include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional, the max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **person** | **String**| Optional. If specified, results will be filtered to include only those containing the specified person. | [optional] | +| **personIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered to include only those containing the specified person id. | [optional] | +| **personTypes** | [**List<String>**](String.md)| Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. | [optional] | +| **studios** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. | [optional] | +| **artists** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited. | [optional] | +| **excludeArtistIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited. | [optional] | +| **artistIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered to include only those containing the specified artist id. | [optional] | +| **albumArtistIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered to include only those containing the specified album artist id. | [optional] | +| **contributingArtistIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered to include only those containing the specified contributing artist id. | [optional] | +| **albums** | [**List<String>**](String.md)| Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited. | [optional] | +| **albumIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited. | [optional] | +| **ids** | [**List<UUID>**](UUID.md)| Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited. | [optional] | +| **videoTypes** | [**List<VideoType>**](VideoType.md)| Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited. | [optional] | +| **minOfficialRating** | **String**| Optional filter by minimum official rating (PG, PG-13, TV-MA, etc). | [optional] | +| **isLocked** | **Boolean**| Optional filter by items that are locked. | [optional] | +| **isPlaceHolder** | **Boolean**| Optional filter by items that are placeholders. | [optional] | +| **hasOfficialRating** | **Boolean**| Optional filter by items that have official ratings. | [optional] | +| **collapseBoxSetItems** | **Boolean**| Whether or not to hide items behind their boxsets. | [optional] | +| **minWidth** | **Integer**| Optional. Filter by the minimum width of the item. | [optional] | +| **minHeight** | **Integer**| Optional. Filter by the minimum height of the item. | [optional] | +| **maxWidth** | **Integer**| Optional. Filter by the maximum width of the item. | [optional] | +| **maxHeight** | **Integer**| Optional. Filter by the maximum height of the item. | [optional] | +| **is3D** | **Boolean**| Optional filter by items that are 3D, or not. | [optional] | +| **seriesStatus** | [**List<SeriesStatus>**](SeriesStatus.md)| Optional filter by Series Status. Allows multiple, comma delimited. | [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] | +| **studioIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. | [optional] | +| **genreIds** | [**List<UUID>**](UUID.md)| Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. | [optional] | +| **enableTotalRecordCount** | **Boolean**| Optional. Enable the total record count. | [optional] [default to true] | +| **enableImages** | **Boolean**| Optional, include image information in output. | [optional] [default to true] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/TranscodeReason.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TranscodeReason.md similarity index 96% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/TranscodeReason.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TranscodeReason.md index f647122d3fe88..7fb95b9f9ec6f 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/TranscodeReason.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TranscodeReason.md @@ -55,5 +55,7 @@ * `VIDEO_RANGE_TYPE_NOT_SUPPORTED` (value: `"VideoRangeTypeNotSupported"`) +* `VIDEO_CODEC_TAG_NOT_SUPPORTED` (value: `"VideoCodecTagNotSupported"`) + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TranscodeSeekInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TranscodeSeekInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TranscodeSeekInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TranscodeSeekInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TranscodingInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TranscodingInfo.md new file mode 100644 index 0000000000000..b5e93b3e78106 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TranscodingInfo.md @@ -0,0 +1,33 @@ + + +# TranscodingInfo + +Class holding information on a runnning transcode. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**audioCodec** | **String** | Gets or sets the thread count used for encoding. | [optional] | +|**videoCodec** | **String** | Gets or sets the thread count used for encoding. | [optional] | +|**container** | **String** | Gets or sets the thread count used for encoding. | [optional] | +|**isVideoDirect** | **Boolean** | Gets or sets a value indicating whether the video is passed through. | [optional] | +|**isAudioDirect** | **Boolean** | Gets or sets a value indicating whether the audio is passed through. | [optional] | +|**bitrate** | **Integer** | Gets or sets the bitrate. | [optional] | +|**framerate** | **Float** | Gets or sets the framerate. | [optional] | +|**completionPercentage** | **Double** | Gets or sets the completion percentage. | [optional] | +|**width** | **Integer** | Gets or sets the video width. | [optional] | +|**height** | **Integer** | Gets or sets the video height. | [optional] | +|**audioChannels** | **Integer** | Gets or sets the audio channels. | [optional] | +|**hardwareAccelerationType** | **HardwareAccelerationType** | Gets or sets the hardware acceleration type. | [optional] | +|**transcodeReasons** | [**TranscodeReasonsEnum**](#TranscodeReasonsEnum) | Gets or sets the transcode reasons. | [optional] | + + + +## Enum: TranscodeReasonsEnum + +| Name | Value | +|---- | -----| + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TranscodingProfile.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TranscodingProfile.md new file mode 100644 index 0000000000000..26af6355922a2 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TranscodingProfile.md @@ -0,0 +1,30 @@ + + +# TranscodingProfile + +A class for transcoding profile information. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**container** | **String** | Gets or sets the container. | [optional] | +|**type** | **DlnaProfileType** | Gets or sets the DLNA profile type. | [optional] | +|**videoCodec** | **String** | Gets or sets the video codec. | [optional] | +|**audioCodec** | **String** | Gets or sets the audio codec. | [optional] | +|**protocol** | **MediaStreamProtocol** | Media streaming protocol. Lowercase for backwards compatibility. | [optional] | +|**estimateContentLength** | **Boolean** | Gets or sets a value indicating whether the content length should be estimated. | [optional] | +|**enableMpegtsM2TsMode** | **Boolean** | Gets or sets a value indicating whether M2TS mode is enabled. | [optional] | +|**transcodeSeekInfo** | **TranscodeSeekInfo** | Gets or sets the transcoding seek info mode. | [optional] | +|**copyTimestamps** | **Boolean** | Gets or sets a value indicating whether timestamps should be copied. | [optional] | +|**context** | **EncodingContext** | Gets or sets the encoding context. | [optional] | +|**enableSubtitlesInManifest** | **Boolean** | Gets or sets a value indicating whether subtitles are allowed in the manifest. | [optional] | +|**maxAudioChannels** | **String** | Gets or sets the maximum audio channels. | [optional] | +|**minSegments** | **Integer** | Gets or sets the minimum amount of segments. | [optional] | +|**segmentLength** | **Integer** | Gets or sets the segment length. | [optional] | +|**breakOnNonKeyFrames** | **Boolean** | Gets or sets a value indicating whether breaking the video stream on non-keyframes is supported. | [optional] | +|**conditions** | [**List<ProfileCondition>**](ProfileCondition.md) | Gets or sets the profile conditions. | [optional] | +|**enableAudioVbrEncoding** | **Boolean** | Gets or sets a value indicating whether variable bitrate encoding is supported. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TransportStreamTimestamp.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TransportStreamTimestamp.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TransportStreamTimestamp.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TransportStreamTimestamp.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrickplayApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrickplayApi.md new file mode 100644 index 0000000000000..2e6208826879b --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrickplayApi.md @@ -0,0 +1,160 @@ +# TrickplayApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getTrickplayHlsPlaylist**](TrickplayApi.md#getTrickplayHlsPlaylist) | **GET** /Videos/{itemId}/Trickplay/{width}/tiles.m3u8 | Gets an image tiles playlist for trickplay. | +| [**getTrickplayTileImage**](TrickplayApi.md#getTrickplayTileImage) | **GET** /Videos/{itemId}/Trickplay/{width}/{index}.jpg | Gets a trickplay tile image. | + + + +# **getTrickplayHlsPlaylist** +> File getTrickplayHlsPlaylist(itemId, width, mediaSourceId) + +Gets an image tiles playlist for trickplay. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.TrickplayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + TrickplayApi apiInstance = new TrickplayApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + Integer width = 56; // Integer | The width of a single tile. + UUID mediaSourceId = UUID.randomUUID(); // UUID | The media version id, if using an alternate version. + try { + File result = apiInstance.getTrickplayHlsPlaylist(itemId, width, mediaSourceId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TrickplayApi#getTrickplayHlsPlaylist"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **width** | **Integer**| The width of a single tile. | | +| **mediaSourceId** | **UUID**| The media version id, if using an alternate version. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/x-mpegURL, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Tiles playlist returned. | - | +| **404** | Not Found | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getTrickplayTileImage** +> File getTrickplayTileImage(itemId, width, index, mediaSourceId) + +Gets a trickplay tile image. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.TrickplayApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + TrickplayApi apiInstance = new TrickplayApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + Integer width = 56; // Integer | The width of a single tile. + Integer index = 56; // Integer | The index of the desired tile. + UUID mediaSourceId = UUID.randomUUID(); // UUID | The media version id, if using an alternate version. + try { + File result = apiInstance.getTrickplayTileImage(itemId, width, index, mediaSourceId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TrickplayApi#getTrickplayTileImage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **width** | **Integer**| The width of a single tile. | | +| **index** | **Integer**| The index of the desired tile. | | +| **mediaSourceId** | **UUID**| The media version id, if using an alternate version. | [optional] | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: image/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Tile image not found at specified index. | - | +| **404** | Not Found | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrickplayInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrickplayInfo.md new file mode 100644 index 0000000000000..e187c4c7b039c --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrickplayInfo.md @@ -0,0 +1,20 @@ + + +# TrickplayInfo + +An entity representing the metadata for a group of trickplay tiles. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**width** | **Integer** | Gets or sets width of an individual thumbnail. | [optional] | +|**height** | **Integer** | Gets or sets height of an individual thumbnail. | [optional] | +|**tileWidth** | **Integer** | Gets or sets amount of thumbnails per row. | [optional] | +|**tileHeight** | **Integer** | Gets or sets amount of thumbnails per column. | [optional] | +|**thumbnailCount** | **Integer** | Gets or sets total amount of non-black thumbnails. | [optional] | +|**interval** | **Integer** | Gets or sets interval in milliseconds between each trickplay thumbnail. | [optional] | +|**bandwidth** | **Integer** | Gets or sets peak bandwith usage in bits per second. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrickplayOptions.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrickplayOptions.md new file mode 100644 index 0000000000000..4394331fe15fe --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrickplayOptions.md @@ -0,0 +1,25 @@ + + +# TrickplayOptions + +Class TrickplayOptions. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**enableHwAcceleration** | **Boolean** | Gets or sets a value indicating whether or not to use HW acceleration. | [optional] | +|**enableHwEncoding** | **Boolean** | Gets or sets a value indicating whether or not to use HW accelerated MJPEG encoding. | [optional] | +|**enableKeyFrameOnlyExtraction** | **Boolean** | Gets or sets a value indicating whether to only extract key frames. Significantly faster, but is not compatible with all decoders and/or video files. | [optional] | +|**scanBehavior** | **TrickplayScanBehavior** | Gets or sets the behavior used by trickplay provider on library scan/update. | [optional] | +|**processPriority** | **ProcessPriorityClass** | Gets or sets the process priority for the ffmpeg process. | [optional] | +|**interval** | **Integer** | Gets or sets the interval, in ms, between each new trickplay image. | [optional] | +|**widthResolutions** | **List<Integer>** | Gets or sets the target width resolutions, in px, to generates preview images for. | [optional] | +|**tileWidth** | **Integer** | Gets or sets number of tile images to allow in X dimension. | [optional] | +|**tileHeight** | **Integer** | Gets or sets number of tile images to allow in Y dimension. | [optional] | +|**qscale** | **Integer** | Gets or sets the ffmpeg output quality level. | [optional] | +|**jpegQuality** | **Integer** | Gets or sets the jpeg quality to use for image tiles. | [optional] | +|**processThreads** | **Integer** | Gets or sets the number of threads to be used by ffmpeg. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrickplayScanBehavior.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrickplayScanBehavior.md new file mode 100644 index 0000000000000..45a384f022727 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TrickplayScanBehavior.md @@ -0,0 +1,13 @@ + + +# TrickplayScanBehavior + +## Enum + + +* `BLOCKING` (value: `"Blocking"`) + +* `NON_BLOCKING` (value: `"NonBlocking"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TunerChannelMapping.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TunerChannelMapping.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TunerChannelMapping.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TunerChannelMapping.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TunerHostInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TunerHostInfo.md new file mode 100644 index 0000000000000..253a6d75a1a00 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TunerHostInfo.md @@ -0,0 +1,27 @@ + + +# TunerHostInfo + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**id** | **String** | | [optional] | +|**url** | **String** | | [optional] | +|**type** | **String** | | [optional] | +|**deviceId** | **String** | | [optional] | +|**friendlyName** | **String** | | [optional] | +|**importFavoritesOnly** | **Boolean** | | [optional] | +|**allowHWTranscoding** | **Boolean** | | [optional] | +|**allowFmp4TranscodingContainer** | **Boolean** | | [optional] | +|**allowStreamSharing** | **Boolean** | | [optional] | +|**fallbackMaxStreamingBitrate** | **Integer** | | [optional] | +|**enableStreamLooping** | **Boolean** | | [optional] | +|**source** | **String** | | [optional] | +|**tunerCount** | **Integer** | | [optional] | +|**userAgent** | **String** | | [optional] | +|**ignoreDts** | **Boolean** | | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TvShowsApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TvShowsApi.md new file mode 100644 index 0000000000000..2f3ca9eb491f2 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TvShowsApi.md @@ -0,0 +1,380 @@ +# TvShowsApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getEpisodes**](TvShowsApi.md#getEpisodes) | **GET** /Shows/{seriesId}/Episodes | Gets episodes for a tv season. | +| [**getNextUp**](TvShowsApi.md#getNextUp) | **GET** /Shows/NextUp | Gets a list of next up episodes. | +| [**getSeasons**](TvShowsApi.md#getSeasons) | **GET** /Shows/{seriesId}/Seasons | Gets seasons for a tv series. | +| [**getUpcomingEpisodes**](TvShowsApi.md#getUpcomingEpisodes) | **GET** /Shows/Upcoming | Gets a list of upcoming episodes. | + + + +# **getEpisodes** +> BaseItemDtoQueryResult getEpisodes(seriesId, userId, fields, season, seasonId, isMissing, adjacentTo, startItemId, startIndex, limit, enableImages, imageTypeLimit, enableImageTypes, enableUserData, sortBy) + +Gets episodes for a tv season. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.TvShowsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + TvShowsApi apiInstance = new TvShowsApi(defaultClient); + UUID seriesId = UUID.randomUUID(); // UUID | The series id. + UUID userId = UUID.randomUUID(); // UUID | The user id. + List fields = Arrays.asList(); // List | 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. + Integer season = 56; // Integer | Optional filter by season number. + UUID seasonId = UUID.randomUUID(); // UUID | Optional. Filter by season id. + Boolean isMissing = true; // Boolean | Optional. Filter by items that are missing episodes or not. + UUID adjacentTo = UUID.randomUUID(); // UUID | Optional. Return items that are siblings of a supplied item. + UUID startItemId = UUID.randomUUID(); // UUID | Optional. Skip through the list until a given item is found. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + Boolean enableImages = true; // Boolean | Optional, include image information in output. + Integer imageTypeLimit = 56; // Integer | Optional, the max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + ItemSortBy sortBy = ItemSortBy.fromValue("Default"); // ItemSortBy | Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. + try { + BaseItemDtoQueryResult result = apiInstance.getEpisodes(seriesId, userId, fields, season, seasonId, isMissing, adjacentTo, startItemId, startIndex, limit, enableImages, imageTypeLimit, enableImageTypes, enableUserData, sortBy); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TvShowsApi#getEpisodes"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **seriesId** | **UUID**| The series id. | | +| **userId** | **UUID**| The user id. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| 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] | +| **season** | **Integer**| Optional filter by season number. | [optional] | +| **seasonId** | **UUID**| Optional. Filter by season id. | [optional] | +| **isMissing** | **Boolean**| Optional. Filter by items that are missing episodes or not. | [optional] | +| **adjacentTo** | **UUID**| Optional. Return items that are siblings of a supplied item. | [optional] | +| **startItemId** | **UUID**| Optional. Skip through the list until a given item is found. | [optional] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **enableImages** | **Boolean**| Optional, include image information in output. | [optional] | +| **imageTypeLimit** | **Integer**| Optional, the max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **sortBy** | **ItemSortBy**| Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. | [optional] [enum: Default, AiredEpisodeOrder, Album, AlbumArtist, Artist, DateCreated, OfficialRating, DatePlayed, PremiereDate, StartDate, SortName, Name, Random, Runtime, CommunityRating, ProductionYear, PlayCount, CriticRating, IsFolder, IsUnplayed, IsPlayed, SeriesSortName, VideoBitRate, AirTime, Studio, IsFavoriteOrLiked, DateLastContentAdded, SeriesDatePlayed, ParentIndexNumber, IndexNumber, SimilarityScore, SearchScore] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | +| **404** | Not Found | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getNextUp** +> BaseItemDtoQueryResult getNextUp(userId, startIndex, limit, fields, seriesId, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData, nextUpDateCutoff, enableTotalRecordCount, disableFirstEpisode, enableResumable, enableRewatching) + +Gets a list of next up episodes. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.TvShowsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + TvShowsApi apiInstance = new TvShowsApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | The user id of the user to get the next up episodes for. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + UUID seriesId = UUID.randomUUID(); // UUID | Optional. Filter by series id. + UUID parentId = UUID.randomUUID(); // UUID | Optional. Specify this to localize the search to a specific item or folder. Omit to use the root. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + OffsetDateTime nextUpDateCutoff = OffsetDateTime.now(); // OffsetDateTime | Optional. Starting date of shows to show in Next Up section. + Boolean enableTotalRecordCount = true; // Boolean | Whether to enable the total records count. Defaults to true. + Boolean disableFirstEpisode = false; // Boolean | Whether to disable sending the first episode in a series as next up. + Boolean enableResumable = true; // Boolean | Whether to include resumable episodes in next up results. + Boolean enableRewatching = false; // Boolean | Whether to include watched episodes in next up results. + try { + BaseItemDtoQueryResult result = apiInstance.getNextUp(userId, startIndex, limit, fields, seriesId, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData, nextUpDateCutoff, enableTotalRecordCount, disableFirstEpisode, enableResumable, enableRewatching); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TvShowsApi#getNextUp"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| The user id of the user to get the next up episodes for. | [optional] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **seriesId** | **UUID**| Optional. Filter by series id. | [optional] | +| **parentId** | **UUID**| Optional. Specify this to localize the search to a specific item or folder. Omit to use the root. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **nextUpDateCutoff** | **OffsetDateTime**| Optional. Starting date of shows to show in Next Up section. | [optional] | +| **enableTotalRecordCount** | **Boolean**| Whether to enable the total records count. Defaults to true. | [optional] [default to true] | +| **disableFirstEpisode** | **Boolean**| Whether to disable sending the first episode in a series as next up. | [optional] [default to false] | +| **enableResumable** | **Boolean**| Whether to include resumable episodes in next up results. | [optional] [default to true] | +| **enableRewatching** | **Boolean**| Whether to include watched episodes in next up results. | [optional] [default to false] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getSeasons** +> BaseItemDtoQueryResult getSeasons(seriesId, userId, fields, isSpecialSeason, isMissing, adjacentTo, enableImages, imageTypeLimit, enableImageTypes, enableUserData) + +Gets seasons for a tv series. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.TvShowsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + TvShowsApi apiInstance = new TvShowsApi(defaultClient); + UUID seriesId = UUID.randomUUID(); // UUID | The series id. + UUID userId = UUID.randomUUID(); // UUID | The user id. + List fields = Arrays.asList(); // List | 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. + Boolean isSpecialSeason = true; // Boolean | Optional. Filter by special season. + Boolean isMissing = true; // Boolean | Optional. Filter by items that are missing episodes or not. + UUID adjacentTo = UUID.randomUUID(); // UUID | Optional. Return items that are siblings of a supplied item. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + try { + BaseItemDtoQueryResult result = apiInstance.getSeasons(seriesId, userId, fields, isSpecialSeason, isMissing, adjacentTo, enableImages, imageTypeLimit, enableImageTypes, enableUserData); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TvShowsApi#getSeasons"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **seriesId** | **UUID**| The series id. | | +| **userId** | **UUID**| The user id. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| 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] | +| **isSpecialSeason** | **Boolean**| Optional. Filter by special season. | [optional] | +| **isMissing** | **Boolean**| Optional. Filter by items that are missing episodes or not. | [optional] | +| **adjacentTo** | **UUID**| Optional. Return items that are siblings of a supplied item. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | +| **404** | Not Found | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getUpcomingEpisodes** +> BaseItemDtoQueryResult getUpcomingEpisodes(userId, startIndex, limit, fields, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData) + +Gets a list of upcoming episodes. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.TvShowsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + TvShowsApi apiInstance = new TvShowsApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | The user id of the user to get the upcoming episodes for. + Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + UUID parentId = UUID.randomUUID(); // UUID | Optional. Specify this to localize the search to a specific item or folder. Omit to use the root. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + try { + BaseItemDtoQueryResult result = apiInstance.getUpcomingEpisodes(userId, startIndex, limit, fields, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TvShowsApi#getUpcomingEpisodes"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| The user id of the user to get the upcoming episodes for. | [optional] | +| **startIndex** | **Integer**| Optional. The record index to start at. All items with a lower index will be dropped from the results. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **parentId** | **UUID**| Optional. Specify this to localize the search to a specific item or folder. Omit to use the root. | [optional] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TypeOptions.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TypeOptions.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/TypeOptions.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/TypeOptions.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UniversalAudioApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UniversalAudioApi.md new file mode 100644 index 0000000000000..e4cbe05006a3c --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UniversalAudioApi.md @@ -0,0 +1,224 @@ +# UniversalAudioApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getUniversalAudioStream**](UniversalAudioApi.md#getUniversalAudioStream) | **GET** /Audio/{itemId}/universal | Gets an audio stream. | +| [**headUniversalAudioStream**](UniversalAudioApi.md#headUniversalAudioStream) | **HEAD** /Audio/{itemId}/universal | Gets an audio stream. | + + + +# **getUniversalAudioStream** +> File getUniversalAudioStream(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, enableAudioVbrEncoding, breakOnNonKeyFrames, enableRedirection) + +Gets an audio stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UniversalAudioApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UniversalAudioApi apiInstance = new UniversalAudioApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + List container = Arrays.asList(); // List | Optional. The audio container. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + UUID userId = UUID.randomUUID(); // UUID | Optional. The user id. + String audioCodec = "audioCodec_example"; // String | Optional. The audio codec to transcode to. + Integer maxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels. + Integer transcodingAudioChannels = 56; // Integer | Optional. The number of how many audio channels to transcode to. + Integer maxStreamingBitrate = 56; // Integer | Optional. The maximum streaming bitrate. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + String transcodingContainer = "transcodingContainer_example"; // String | Optional. The container to transcode to. + MediaStreamProtocol transcodingProtocol = MediaStreamProtocol.fromValue("http"); // MediaStreamProtocol | Optional. The transcoding protocol. + Integer maxAudioSampleRate = 56; // Integer | Optional. The maximum audio sample rate. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Boolean enableRemoteMedia = true; // Boolean | Optional. Whether to enable remote media. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + Boolean breakOnNonKeyFrames = false; // Boolean | Optional. Whether to break on non key frames. + Boolean enableRedirection = true; // Boolean | Whether to enable redirection. Defaults to true. + try { + File result = apiInstance.getUniversalAudioStream(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, enableAudioVbrEncoding, breakOnNonKeyFrames, enableRedirection); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UniversalAudioApi#getUniversalAudioStream"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **container** | [**List<String>**](String.md)| Optional. The audio container. | [optional] | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **userId** | **UUID**| Optional. The user id. | [optional] | +| **audioCodec** | **String**| Optional. The audio codec to transcode to. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. The maximum number of audio channels. | [optional] | +| **transcodingAudioChannels** | **Integer**| Optional. The number of how many audio channels to transcode to. | [optional] | +| **maxStreamingBitrate** | **Integer**| Optional. The maximum streaming bitrate. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **transcodingContainer** | **String**| Optional. The container to transcode to. | [optional] | +| **transcodingProtocol** | **MediaStreamProtocol**| Optional. The transcoding protocol. | [optional] [enum: http, hls] | +| **maxAudioSampleRate** | **Integer**| Optional. The maximum audio sample rate. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **enableRemoteMedia** | **Boolean**| Optional. Whether to enable remote media. | [optional] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] [default to false] | +| **enableRedirection** | **Boolean**| Whether to enable redirection. Defaults to true. | [optional] [default to true] | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: audio/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Audio stream returned. | - | +| **302** | Redirected to remote audio stream. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **headUniversalAudioStream** +> File headUniversalAudioStream(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, enableAudioVbrEncoding, breakOnNonKeyFrames, enableRedirection) + +Gets an audio stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UniversalAudioApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UniversalAudioApi apiInstance = new UniversalAudioApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + List container = Arrays.asList(); // List | Optional. The audio container. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + UUID userId = UUID.randomUUID(); // UUID | Optional. The user id. + String audioCodec = "audioCodec_example"; // String | Optional. The audio codec to transcode to. + Integer maxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels. + Integer transcodingAudioChannels = 56; // Integer | Optional. The number of how many audio channels to transcode to. + Integer maxStreamingBitrate = 56; // Integer | Optional. The maximum streaming bitrate. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + String transcodingContainer = "transcodingContainer_example"; // String | Optional. The container to transcode to. + MediaStreamProtocol transcodingProtocol = MediaStreamProtocol.fromValue("http"); // MediaStreamProtocol | Optional. The transcoding protocol. + Integer maxAudioSampleRate = 56; // Integer | Optional. The maximum audio sample rate. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Boolean enableRemoteMedia = true; // Boolean | Optional. Whether to enable remote media. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + Boolean breakOnNonKeyFrames = false; // Boolean | Optional. Whether to break on non key frames. + Boolean enableRedirection = true; // Boolean | Whether to enable redirection. Defaults to true. + try { + File result = apiInstance.headUniversalAudioStream(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, enableAudioVbrEncoding, breakOnNonKeyFrames, enableRedirection); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UniversalAudioApi#headUniversalAudioStream"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **container** | [**List<String>**](String.md)| Optional. The audio container. | [optional] | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **userId** | **UUID**| Optional. The user id. | [optional] | +| **audioCodec** | **String**| Optional. The audio codec to transcode to. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. The maximum number of audio channels. | [optional] | +| **transcodingAudioChannels** | **Integer**| Optional. The number of how many audio channels to transcode to. | [optional] | +| **maxStreamingBitrate** | **Integer**| Optional. The maximum streaming bitrate. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **transcodingContainer** | **String**| Optional. The container to transcode to. | [optional] | +| **transcodingProtocol** | **MediaStreamProtocol**| Optional. The transcoding protocol. | [optional] [enum: http, hls] | +| **maxAudioSampleRate** | **Integer**| Optional. The maximum audio sample rate. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **enableRemoteMedia** | **Boolean**| Optional. Whether to enable remote media. | [optional] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] [default to false] | +| **enableRedirection** | **Boolean**| Whether to enable redirection. Defaults to true. | [optional] [default to true] | + +### Return type + +[**File**](File.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: audio/*, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Audio stream returned. | - | +| **302** | Redirected to remote audio stream. | - | +| **404** | Item not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/UnratedItem.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UnratedItem.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/UnratedItem.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UnratedItem.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/UpdateLibraryOptionsDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UpdateLibraryOptionsDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/UpdateLibraryOptionsDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UpdateLibraryOptionsDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/UpdateMediaPathRequestDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UpdateMediaPathRequestDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/UpdateMediaPathRequestDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UpdateMediaPathRequestDto.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UpdatePlaylistDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UpdatePlaylistDto.md new file mode 100644 index 0000000000000..29486e771e16b --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UpdatePlaylistDto.md @@ -0,0 +1,17 @@ + + +# UpdatePlaylistDto + +Update existing playlist dto. Fields set to `null` will not be updated and keep their current values. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**name** | **String** | Gets or sets the name of the new playlist. | [optional] | +|**ids** | **List<UUID>** | Gets or sets item ids of the playlist. | [optional] | +|**users** | [**List<PlaylistUserPermissions>**](PlaylistUserPermissions.md) | Gets or sets the playlist users. | [optional] | +|**isPublic** | **Boolean** | Gets or sets a value indicating whether the playlist is public. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UpdatePlaylistUserDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UpdatePlaylistUserDto.md new file mode 100644 index 0000000000000..007db5552a054 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UpdatePlaylistUserDto.md @@ -0,0 +1,14 @@ + + +# UpdatePlaylistUserDto + +Update existing playlist user dto. Fields set to `null` will not be updated and keep their current values. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**canEdit** | **Boolean** | Gets or sets a value indicating whether the user can edit the playlist. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UpdateUserItemDataDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UpdateUserItemDataDto.md new file mode 100644 index 0000000000000..76650f54ec3ee --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UpdateUserItemDataDto.md @@ -0,0 +1,24 @@ + + +# UpdateUserItemDataDto + +This is used by the api to get information about a item user data. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**rating** | **Double** | Gets or sets the rating. | [optional] | +|**playedPercentage** | **Double** | Gets or sets the played percentage. | [optional] | +|**unplayedItemCount** | **Integer** | Gets or sets the unplayed item count. | [optional] | +|**playbackPositionTicks** | **Long** | Gets or sets the playback position ticks. | [optional] | +|**playCount** | **Integer** | Gets or sets the play count. | [optional] | +|**isFavorite** | **Boolean** | Gets or sets a value indicating whether this instance is favorite. | [optional] | +|**likes** | **Boolean** | Gets or sets a value indicating whether this MediaBrowser.Model.Dto.UpdateUserItemDataDto is likes. | [optional] | +|**lastPlayedDate** | **OffsetDateTime** | Gets or sets the last played date. | [optional] | +|**played** | **Boolean** | Gets or sets a value indicating whether this MediaBrowser.Model.Dto.UserItemDataDto is played. | [optional] | +|**key** | **String** | Gets or sets the key. | [optional] | +|**itemId** | **String** | Gets or sets the item identifier. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/UpdateUserPassword.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UpdateUserPassword.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/UpdateUserPassword.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UpdateUserPassword.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/UploadSubtitleDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UploadSubtitleDto.md similarity index 79% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/UploadSubtitleDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UploadSubtitleDto.md index c721637bb0fbd..cf5e8ac337e4e 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/UploadSubtitleDto.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UploadSubtitleDto.md @@ -11,6 +11,7 @@ Upload subtitles dto. |**language** | **String** | Gets or sets the subtitle language. | | |**format** | **String** | Gets or sets the subtitle format. | | |**isForced** | **Boolean** | Gets or sets a value indicating whether the subtitle is forced. | | +|**isHearingImpaired** | **Boolean** | Gets or sets a value indicating whether the subtitle is for hearing impaired. | | |**data** | **String** | Gets or sets the subtitle data. | | diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserApi.md new file mode 100644 index 0000000000000..0b9f9e733115f --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserApi.md @@ -0,0 +1,947 @@ +# UserApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**authenticateUserByName**](UserApi.md#authenticateUserByName) | **POST** /Users/AuthenticateByName | Authenticates a user by name. | +| [**authenticateWithQuickConnect**](UserApi.md#authenticateWithQuickConnect) | **POST** /Users/AuthenticateWithQuickConnect | Authenticates a user with quick connect. | +| [**createUserByName**](UserApi.md#createUserByName) | **POST** /Users/New | Creates a user. | +| [**deleteUser**](UserApi.md#deleteUser) | **DELETE** /Users/{userId} | Deletes a user. | +| [**forgotPassword**](UserApi.md#forgotPassword) | **POST** /Users/ForgotPassword | Initiates the forgot password process for a local user. | +| [**forgotPasswordPin**](UserApi.md#forgotPasswordPin) | **POST** /Users/ForgotPassword/Pin | Redeems a forgot password pin. | +| [**getCurrentUser**](UserApi.md#getCurrentUser) | **GET** /Users/Me | Gets the user based on auth token. | +| [**getPublicUsers**](UserApi.md#getPublicUsers) | **GET** /Users/Public | Gets a list of publicly visible users for display on a login screen. | +| [**getUserById**](UserApi.md#getUserById) | **GET** /Users/{userId} | Gets a user by Id. | +| [**getUsers**](UserApi.md#getUsers) | **GET** /Users | Gets a list of users. | +| [**updateUser**](UserApi.md#updateUser) | **POST** /Users | Updates a user. | +| [**updateUserConfiguration**](UserApi.md#updateUserConfiguration) | **POST** /Users/Configuration | Updates a user configuration. | +| [**updateUserPassword**](UserApi.md#updateUserPassword) | **POST** /Users/Password | Updates a user's password. | +| [**updateUserPolicy**](UserApi.md#updateUserPolicy) | **POST** /Users/{userId}/Policy | Updates a user policy. | + + + +# **authenticateUserByName** +> AuthenticationResult authenticateUserByName(authenticateUserByName) + +Authenticates a user by name. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + UserApi apiInstance = new UserApi(defaultClient); + AuthenticateUserByName authenticateUserByName = new AuthenticateUserByName(); // AuthenticateUserByName | The M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName) request. + try { + AuthenticationResult result = apiInstance.authenticateUserByName(authenticateUserByName); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserApi#authenticateUserByName"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **authenticateUserByName** | [**AuthenticateUserByName**](AuthenticateUserByName.md)| The M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName) request. | | + +### Return type + +[**AuthenticationResult**](AuthenticationResult.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | User authenticated. | - | + + +# **authenticateWithQuickConnect** +> AuthenticationResult authenticateWithQuickConnect(quickConnectDto) + +Authenticates a user with quick connect. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + UserApi apiInstance = new UserApi(defaultClient); + QuickConnectDto quickConnectDto = new QuickConnectDto(); // QuickConnectDto | The Jellyfin.Api.Models.UserDtos.QuickConnectDto request. + try { + AuthenticationResult result = apiInstance.authenticateWithQuickConnect(quickConnectDto); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserApi#authenticateWithQuickConnect"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **quickConnectDto** | [**QuickConnectDto**](QuickConnectDto.md)| The Jellyfin.Api.Models.UserDtos.QuickConnectDto request. | | + +### Return type + +[**AuthenticationResult**](AuthenticationResult.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | User authenticated. | - | +| **400** | Missing token. | - | + + +# **createUserByName** +> UserDto createUserByName(createUserByName) + +Creates a user. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserApi apiInstance = new UserApi(defaultClient); + CreateUserByName createUserByName = new CreateUserByName(); // CreateUserByName | The create user by name request body. + try { + UserDto result = apiInstance.createUserByName(createUserByName); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserApi#createUserByName"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **createUserByName** | [**CreateUserByName**](CreateUserByName.md)| The create user by name request body. | | + +### Return type + +[**UserDto**](UserDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | User created. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **deleteUser** +> deleteUser(userId) + +Deletes a user. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserApi apiInstance = new UserApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | The user id. + try { + apiInstance.deleteUser(userId); + } catch (ApiException e) { + System.err.println("Exception when calling UserApi#deleteUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| The user id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | User deleted. | - | +| **404** | User not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **forgotPassword** +> ForgotPasswordResult forgotPassword(forgotPasswordDto) + +Initiates the forgot password process for a local user. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + UserApi apiInstance = new UserApi(defaultClient); + ForgotPasswordDto forgotPasswordDto = new ForgotPasswordDto(); // ForgotPasswordDto | The forgot password request containing the entered username. + try { + ForgotPasswordResult result = apiInstance.forgotPassword(forgotPasswordDto); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserApi#forgotPassword"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **forgotPasswordDto** | [**ForgotPasswordDto**](ForgotPasswordDto.md)| The forgot password request containing the entered username. | | + +### Return type + +[**ForgotPasswordResult**](ForgotPasswordResult.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Password reset process started. | - | + + +# **forgotPasswordPin** +> PinRedeemResult forgotPasswordPin(forgotPasswordPinDto) + +Redeems a forgot password pin. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + UserApi apiInstance = new UserApi(defaultClient); + ForgotPasswordPinDto forgotPasswordPinDto = new ForgotPasswordPinDto(); // ForgotPasswordPinDto | The forgot password pin request containing the entered pin. + try { + PinRedeemResult result = apiInstance.forgotPasswordPin(forgotPasswordPinDto); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserApi#forgotPasswordPin"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **forgotPasswordPinDto** | [**ForgotPasswordPinDto**](ForgotPasswordPinDto.md)| The forgot password pin request containing the entered pin. | | + +### Return type + +[**PinRedeemResult**](PinRedeemResult.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Pin reset process started. | - | + + +# **getCurrentUser** +> UserDto getCurrentUser() + +Gets the user based on auth token. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserApi apiInstance = new UserApi(defaultClient); + try { + UserDto result = apiInstance.getCurrentUser(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserApi#getCurrentUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**UserDto**](UserDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | User returned. | - | +| **400** | Token is not owned by a user. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getPublicUsers** +> List<UserDto> getPublicUsers() + +Gets a list of publicly visible users for display on a login screen. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + UserApi apiInstance = new UserApi(defaultClient); + try { + List result = apiInstance.getPublicUsers(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserApi#getPublicUsers"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<UserDto>**](UserDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Public users returned. | - | + + +# **getUserById** +> UserDto getUserById(userId) + +Gets a user by Id. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserApi apiInstance = new UserApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | The user id. + try { + UserDto result = apiInstance.getUserById(userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserApi#getUserById"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| The user id. | | + +### Return type + +[**UserDto**](UserDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | User returned. | - | +| **404** | User not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getUsers** +> List<UserDto> getUsers(isHidden, isDisabled) + +Gets a list of users. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserApi apiInstance = new UserApi(defaultClient); + Boolean isHidden = true; // Boolean | Optional filter by IsHidden=true or false. + Boolean isDisabled = true; // Boolean | Optional filter by IsDisabled=true or false. + try { + List result = apiInstance.getUsers(isHidden, isDisabled); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserApi#getUsers"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **isHidden** | **Boolean**| Optional filter by IsHidden=true or false. | [optional] | +| **isDisabled** | **Boolean**| Optional filter by IsDisabled=true or false. | [optional] | + +### Return type + +[**List<UserDto>**](UserDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Users returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateUser** +> updateUser(userDto, userId) + +Updates a user. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserApi apiInstance = new UserApi(defaultClient); + UserDto userDto = new UserDto(); // UserDto | The updated user model. + UUID userId = UUID.randomUUID(); // UUID | The user id. + try { + apiInstance.updateUser(userDto, userId); + } catch (ApiException e) { + System.err.println("Exception when calling UserApi#updateUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userDto** | [**UserDto**](UserDto.md)| The updated user model. | | +| **userId** | **UUID**| The user id. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | User updated. | - | +| **400** | User information was not supplied. | - | +| **403** | User update forbidden. | - | +| **401** | Unauthorized | - | + + +# **updateUserConfiguration** +> updateUserConfiguration(userConfiguration, userId) + +Updates a user configuration. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserApi apiInstance = new UserApi(defaultClient); + UserConfiguration userConfiguration = new UserConfiguration(); // UserConfiguration | The new user configuration. + UUID userId = UUID.randomUUID(); // UUID | The user id. + try { + apiInstance.updateUserConfiguration(userConfiguration, userId); + } catch (ApiException e) { + System.err.println("Exception when calling UserApi#updateUserConfiguration"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userConfiguration** | [**UserConfiguration**](UserConfiguration.md)| The new user configuration. | | +| **userId** | **UUID**| The user id. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | User configuration updated. | - | +| **403** | User configuration update forbidden. | - | +| **401** | Unauthorized | - | + + +# **updateUserPassword** +> updateUserPassword(updateUserPassword, userId) + +Updates a user's password. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserApi apiInstance = new UserApi(defaultClient); + UpdateUserPassword updateUserPassword = new UpdateUserPassword(); // UpdateUserPassword | The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. + UUID userId = UUID.randomUUID(); // UUID | The user id. + try { + apiInstance.updateUserPassword(updateUserPassword, userId); + } catch (ApiException e) { + System.err.println("Exception when calling UserApi#updateUserPassword"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **updateUserPassword** | [**UpdateUserPassword**](UpdateUserPassword.md)| The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. | | +| **userId** | **UUID**| The user id. | [optional] | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Password successfully reset. | - | +| **403** | User is not allowed to update the password. | - | +| **404** | User not found. | - | +| **401** | Unauthorized | - | + + +# **updateUserPolicy** +> updateUserPolicy(userId, userPolicy) + +Updates a user policy. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserApi apiInstance = new UserApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | The user id. + UserPolicy userPolicy = new UserPolicy(); // UserPolicy | The new user policy. + try { + apiInstance.updateUserPolicy(userId, userPolicy); + } catch (ApiException e) { + System.err.println("Exception when calling UserApi#updateUserPolicy"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| The user id. | | +| **userPolicy** | [**UserPolicy**](UserPolicy.md)| The new user policy. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, text/json, application/*+json + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | User policy updated. | - | +| **400** | User policy was not supplied. | - | +| **403** | User policy update forbidden. | - | +| **401** | Unauthorized | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserConfiguration.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserConfiguration.md new file mode 100644 index 0000000000000..b9568f1ab14ab --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserConfiguration.md @@ -0,0 +1,29 @@ + + +# UserConfiguration + +Class UserConfiguration. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**audioLanguagePreference** | **String** | Gets or sets the audio language preference. | [optional] | +|**playDefaultAudioTrack** | **Boolean** | Gets or sets a value indicating whether [play default audio track]. | [optional] | +|**subtitleLanguagePreference** | **String** | Gets or sets the subtitle language preference. | [optional] | +|**displayMissingEpisodes** | **Boolean** | | [optional] | +|**groupedFolders** | **List<UUID>** | | [optional] | +|**subtitleMode** | **SubtitlePlaybackMode** | An enum representing a subtitle playback mode. | [optional] | +|**displayCollectionsView** | **Boolean** | | [optional] | +|**enableLocalPassword** | **Boolean** | | [optional] | +|**orderedViews** | **List<UUID>** | | [optional] | +|**latestItemsExcludes** | **List<UUID>** | | [optional] | +|**myMediaExcludes** | **List<UUID>** | | [optional] | +|**hidePlayedInLatest** | **Boolean** | | [optional] | +|**rememberAudioSelections** | **Boolean** | | [optional] | +|**rememberSubtitleSelections** | **Boolean** | | [optional] | +|**enableNextEpisodeAutoPlay** | **Boolean** | | [optional] | +|**castReceiverId** | **String** | Gets or sets the id of the selected cast receiver. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserDataChangeInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserDataChangeInfo.md new file mode 100644 index 0000000000000..29edf67e738a9 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserDataChangeInfo.md @@ -0,0 +1,15 @@ + + +# UserDataChangeInfo + +Class UserDataChangeInfo. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**userId** | **UUID** | Gets or sets the user id. | [optional] | +|**userDataList** | [**List<UserItemDataDto>**](UserItemDataDto.md) | Gets or sets the user data list. | [optional] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserDataChangedMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserDataChangedMessage.md new file mode 100644 index 0000000000000..57b9a44635913 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserDataChangedMessage.md @@ -0,0 +1,16 @@ + + +# UserDataChangedMessage + +User data changed message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**UserDataChangeInfo**](UserDataChangeInfo.md) | Class UserDataChangeInfo. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserDeletedMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserDeletedMessage.md new file mode 100644 index 0000000000000..f173c29403f3b --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserDeletedMessage.md @@ -0,0 +1,16 @@ + + +# UserDeletedMessage + +User deleted message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | **UUID** | Gets or sets the data. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/UserDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/UserDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/UserItemDataDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserItemDataDto.md similarity index 93% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/UserItemDataDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserItemDataDto.md index f5a79b89ab2fa..3896286228825 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/UserItemDataDto.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserItemDataDto.md @@ -18,7 +18,7 @@ Class UserItemDataDto. |**lastPlayedDate** | **OffsetDateTime** | Gets or sets the last played date. | [optional] | |**played** | **Boolean** | Gets or sets a value indicating whether this MediaBrowser.Model.Dto.UserItemDataDto is played. | [optional] | |**key** | **String** | Gets or sets the key. | [optional] | -|**itemId** | **String** | Gets or sets the item identifier. | [optional] | +|**itemId** | **UUID** | Gets or sets the item identifier. | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserLibraryApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserLibraryApi.md new file mode 100644 index 0000000000000..7a46683d593a9 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserLibraryApi.md @@ -0,0 +1,746 @@ +# UserLibraryApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**deleteUserItemRating**](UserLibraryApi.md#deleteUserItemRating) | **DELETE** /UserItems/{itemId}/Rating | Deletes a user's saved personal rating for an item. | +| [**getIntros**](UserLibraryApi.md#getIntros) | **GET** /Items/{itemId}/Intros | Gets intros to play before the main media item plays. | +| [**getItem**](UserLibraryApi.md#getItem) | **GET** /Items/{itemId} | Gets an item from a user's library. | +| [**getLatestMedia**](UserLibraryApi.md#getLatestMedia) | **GET** /Items/Latest | Gets latest media. | +| [**getLocalTrailers**](UserLibraryApi.md#getLocalTrailers) | **GET** /Items/{itemId}/LocalTrailers | Gets local trailers for an item. | +| [**getRootFolder**](UserLibraryApi.md#getRootFolder) | **GET** /Items/Root | Gets the root folder from a user's library. | +| [**getSpecialFeatures**](UserLibraryApi.md#getSpecialFeatures) | **GET** /Items/{itemId}/SpecialFeatures | Gets special features for an item. | +| [**markFavoriteItem**](UserLibraryApi.md#markFavoriteItem) | **POST** /UserFavoriteItems/{itemId} | Marks an item as a favorite. | +| [**unmarkFavoriteItem**](UserLibraryApi.md#unmarkFavoriteItem) | **DELETE** /UserFavoriteItems/{itemId} | Unmarks item as a favorite. | +| [**updateUserItemRating**](UserLibraryApi.md#updateUserItemRating) | **POST** /UserItems/{itemId}/Rating | Updates a user's rating for an item. | + + + +# **deleteUserItemRating** +> UserItemDataDto deleteUserItemRating(itemId, userId) + +Deletes a user's saved personal rating for an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserLibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserLibraryApi apiInstance = new UserLibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + UUID userId = UUID.randomUUID(); // UUID | User id. + try { + UserItemDataDto result = apiInstance.deleteUserItemRating(itemId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserLibraryApi#deleteUserItemRating"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **userId** | **UUID**| User id. | [optional] | + +### Return type + +[**UserItemDataDto**](UserItemDataDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Personal rating removed. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getIntros** +> BaseItemDtoQueryResult getIntros(itemId, userId) + +Gets intros to play before the main media item plays. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserLibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserLibraryApi apiInstance = new UserLibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + UUID userId = UUID.randomUUID(); // UUID | User id. + try { + BaseItemDtoQueryResult result = apiInstance.getIntros(itemId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserLibraryApi#getIntros"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **userId** | **UUID**| User id. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Intros returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getItem** +> BaseItemDto getItem(itemId, userId) + +Gets an item from a user's library. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserLibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserLibraryApi apiInstance = new UserLibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + UUID userId = UUID.randomUUID(); // UUID | User id. + try { + BaseItemDto result = apiInstance.getItem(itemId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserLibraryApi#getItem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **userId** | **UUID**| User id. | [optional] | + +### Return type + +[**BaseItemDto**](BaseItemDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Item returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getLatestMedia** +> List<BaseItemDto> getLatestMedia(userId, parentId, fields, includeItemTypes, isPlayed, enableImages, imageTypeLimit, enableImageTypes, enableUserData, limit, groupItems) + +Gets latest media. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserLibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserLibraryApi apiInstance = new UserLibraryApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | User id. + UUID parentId = UUID.randomUUID(); // UUID | Specify this to localize the search to a specific item or folder. Omit to use the root. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + List includeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. + Boolean isPlayed = true; // Boolean | Filter by items that are played, or not. + Boolean enableImages = true; // Boolean | Optional. include image information in output. + Integer imageTypeLimit = 56; // Integer | Optional. the max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + Boolean enableUserData = true; // Boolean | Optional. include user data. + Integer limit = 20; // Integer | Return item limit. + Boolean groupItems = true; // Boolean | Whether or not to group items into a parent container. + try { + List result = apiInstance.getLatestMedia(userId, parentId, fields, includeItemTypes, isPlayed, enableImages, imageTypeLimit, enableImageTypes, enableUserData, limit, groupItems); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserLibraryApi#getLatestMedia"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| User id. | [optional] | +| **parentId** | **UUID**| Specify this to localize the search to a specific item or folder. Omit to use the root. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **includeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. | [optional] | +| **isPlayed** | **Boolean**| Filter by items that are played, or not. | [optional] | +| **enableImages** | **Boolean**| Optional. include image information in output. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. the max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **enableUserData** | **Boolean**| Optional. include user data. | [optional] | +| **limit** | **Integer**| Return item limit. | [optional] [default to 20] | +| **groupItems** | **Boolean**| Whether or not to group items into a parent container. | [optional] [default to true] | + +### Return type + +[**List<BaseItemDto>**](BaseItemDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Latest media returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getLocalTrailers** +> List<BaseItemDto> getLocalTrailers(itemId, userId) + +Gets local trailers for an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserLibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserLibraryApi apiInstance = new UserLibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + UUID userId = UUID.randomUUID(); // UUID | User id. + try { + List result = apiInstance.getLocalTrailers(itemId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserLibraryApi#getLocalTrailers"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **userId** | **UUID**| User id. | [optional] | + +### Return type + +[**List<BaseItemDto>**](BaseItemDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | An Microsoft.AspNetCore.Mvc.OkResult containing the item's local trailers. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getRootFolder** +> BaseItemDto getRootFolder(userId) + +Gets the root folder from a user's library. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserLibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserLibraryApi apiInstance = new UserLibraryApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | User id. + try { + BaseItemDto result = apiInstance.getRootFolder(userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserLibraryApi#getRootFolder"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| User id. | [optional] | + +### Return type + +[**BaseItemDto**](BaseItemDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Root folder returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getSpecialFeatures** +> List<BaseItemDto> getSpecialFeatures(itemId, userId) + +Gets special features for an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserLibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserLibraryApi apiInstance = new UserLibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + UUID userId = UUID.randomUUID(); // UUID | User id. + try { + List result = apiInstance.getSpecialFeatures(itemId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserLibraryApi#getSpecialFeatures"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **userId** | **UUID**| User id. | [optional] | + +### Return type + +[**List<BaseItemDto>**](BaseItemDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Special features returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **markFavoriteItem** +> UserItemDataDto markFavoriteItem(itemId, userId) + +Marks an item as a favorite. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserLibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserLibraryApi apiInstance = new UserLibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + UUID userId = UUID.randomUUID(); // UUID | User id. + try { + UserItemDataDto result = apiInstance.markFavoriteItem(itemId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserLibraryApi#markFavoriteItem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **userId** | **UUID**| User id. | [optional] | + +### Return type + +[**UserItemDataDto**](UserItemDataDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Item marked as favorite. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **unmarkFavoriteItem** +> UserItemDataDto unmarkFavoriteItem(itemId, userId) + +Unmarks item as a favorite. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserLibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserLibraryApi apiInstance = new UserLibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + UUID userId = UUID.randomUUID(); // UUID | User id. + try { + UserItemDataDto result = apiInstance.unmarkFavoriteItem(itemId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserLibraryApi#unmarkFavoriteItem"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **userId** | **UUID**| User id. | [optional] | + +### Return type + +[**UserItemDataDto**](UserItemDataDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Item unmarked as favorite. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **updateUserItemRating** +> UserItemDataDto updateUserItemRating(itemId, userId, likes) + +Updates a user's rating for an item. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserLibraryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserLibraryApi apiInstance = new UserLibraryApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | Item id. + UUID userId = UUID.randomUUID(); // UUID | User id. + Boolean likes = true; // Boolean | Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean}) is likes. + try { + UserItemDataDto result = apiInstance.updateUserItemRating(itemId, userId, likes); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserLibraryApi#updateUserItemRating"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| Item id. | | +| **userId** | **UUID**| User id. | [optional] | +| **likes** | **Boolean**| Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean}) is likes. | [optional] | + +### Return type + +[**UserItemDataDto**](UserItemDataDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Item rating updated. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/UserPolicy.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserPolicy.md similarity index 80% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/UserPolicy.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserPolicy.md index c2af1ec0670c0..8b39a7c40cf65 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/docs/UserPolicy.md +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserPolicy.md @@ -9,9 +9,13 @@ |------------ | ------------- | ------------- | -------------| |**isAdministrator** | **Boolean** | Gets or sets a value indicating whether this instance is administrator. | [optional] | |**isHidden** | **Boolean** | Gets or sets a value indicating whether this instance is hidden. | [optional] | +|**enableCollectionManagement** | **Boolean** | Gets or sets a value indicating whether this instance can manage collections. | [optional] | +|**enableSubtitleManagement** | **Boolean** | Gets or sets a value indicating whether this instance can manage subtitles. | [optional] | +|**enableLyricManagement** | **Boolean** | Gets or sets a value indicating whether this user can manage lyrics. | [optional] | |**isDisabled** | **Boolean** | Gets or sets a value indicating whether this instance is disabled. | [optional] | |**maxParentalRating** | **Integer** | Gets or sets the max parental rating. | [optional] | |**blockedTags** | **List<String>** | | [optional] | +|**allowedTags** | **List<String>** | | [optional] | |**enableUserPreferenceAccess** | **Boolean** | | [optional] | |**accessSchedules** | [**List<AccessSchedule>**](AccessSchedule.md) | | [optional] | |**blockUnratedItems** | **List<UnratedItem>** | | [optional] | @@ -43,9 +47,9 @@ |**blockedMediaFolders** | **List<UUID>** | | [optional] | |**blockedChannels** | **List<UUID>** | | [optional] | |**remoteClientBitrateLimit** | **Integer** | | [optional] | -|**authenticationProviderId** | **String** | | [optional] | -|**passwordResetProviderId** | **String** | | [optional] | -|**syncPlayAccess** | **SyncPlayUserAccessType** | Gets or sets a value indicating what SyncPlay features the user can access. | [optional] | +|**authenticationProviderId** | **String** | | | +|**passwordResetProviderId** | **String** | | | +|**syncPlayAccess** | **SyncPlayUserAccessType** | Enum SyncPlayUserAccessType. | [optional] | diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserUpdatedMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserUpdatedMessage.md new file mode 100644 index 0000000000000..34c2c09496e0b --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserUpdatedMessage.md @@ -0,0 +1,16 @@ + + +# UserUpdatedMessage + +User updated message. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**UserDto**](UserDto.md) | Class UserDto. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserViewsApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserViewsApi.md new file mode 100644 index 0000000000000..2573b00f16c55 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UserViewsApi.md @@ -0,0 +1,155 @@ +# UserViewsApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getGroupingOptions**](UserViewsApi.md#getGroupingOptions) | **GET** /UserViews/GroupingOptions | Get user view grouping options. | +| [**getUserViews**](UserViewsApi.md#getUserViews) | **GET** /UserViews | Get user views. | + + + +# **getGroupingOptions** +> List<SpecialViewOptionDto> getGroupingOptions(userId) + +Get user view grouping options. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserViewsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserViewsApi apiInstance = new UserViewsApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | User id. + try { + List result = apiInstance.getGroupingOptions(userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserViewsApi#getGroupingOptions"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| User id. | [optional] | + +### Return type + +[**List<SpecialViewOptionDto>**](SpecialViewOptionDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | User view grouping options returned. | - | +| **404** | User not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getUserViews** +> BaseItemDtoQueryResult getUserViews(userId, includeExternalContent, presetViews, includeHidden) + +Get user views. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserViewsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + UserViewsApi apiInstance = new UserViewsApi(defaultClient); + UUID userId = UUID.randomUUID(); // UUID | User id. + Boolean includeExternalContent = true; // Boolean | Whether or not to include external views such as channels or live tv. + List presetViews = Arrays.asList(); // List | Preset views. + Boolean includeHidden = false; // Boolean | Whether or not to include hidden content. + try { + BaseItemDtoQueryResult result = apiInstance.getUserViews(userId, includeExternalContent, presetViews, includeHidden); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UserViewsApi#getUserViews"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **userId** | **UUID**| User id. | [optional] | +| **includeExternalContent** | **Boolean**| Whether or not to include external views such as channels or live tv. | [optional] | +| **presetViews** | [**List<CollectionType>**](CollectionType.md)| Preset views. | [optional] | +| **includeHidden** | **Boolean**| Whether or not to include hidden content. | [optional] [default to false] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | User views returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/UtcTimeResponse.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UtcTimeResponse.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/UtcTimeResponse.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/UtcTimeResponse.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ValidatePathDto.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ValidatePathDto.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/ValidatePathDto.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/ValidatePathDto.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/VersionInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VersionInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/VersionInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VersionInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/Video3DFormat.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/Video3DFormat.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/Video3DFormat.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/Video3DFormat.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VideoAttachmentsApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VideoAttachmentsApi.md new file mode 100644 index 0000000000000..db36ace28fd0b --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VideoAttachmentsApi.md @@ -0,0 +1,74 @@ +# VideoAttachmentsApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getAttachment**](VideoAttachmentsApi.md#getAttachment) | **GET** /Videos/{videoId}/{mediaSourceId}/Attachments/{index} | Get video attachment. | + + + +# **getAttachment** +> File getAttachment(videoId, mediaSourceId, index) + +Get video attachment. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.VideoAttachmentsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + VideoAttachmentsApi apiInstance = new VideoAttachmentsApi(defaultClient); + UUID videoId = UUID.randomUUID(); // UUID | Video ID. + String mediaSourceId = "mediaSourceId_example"; // String | Media Source ID. + Integer index = 56; // Integer | Attachment Index. + try { + File result = apiInstance.getAttachment(videoId, mediaSourceId, index); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling VideoAttachmentsApi#getAttachment"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **videoId** | **UUID**| Video ID. | | +| **mediaSourceId** | **String**| Media Source ID. | | +| **index** | **Integer**| Attachment Index. | | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream, application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Attachment retrieved. | - | +| **404** | Video or attachment not found. | - | + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VideoRange.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VideoRange.md new file mode 100644 index 0000000000000..9eb81665d4e5d --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VideoRange.md @@ -0,0 +1,15 @@ + + +# VideoRange + +## Enum + + +* `UNKNOWN` (value: `"Unknown"`) + +* `SDR` (value: `"SDR"`) + +* `HDR` (value: `"HDR"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VideoRangeType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VideoRangeType.md new file mode 100644 index 0000000000000..51b7eeee44e91 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VideoRangeType.md @@ -0,0 +1,27 @@ + + +# VideoRangeType + +## Enum + + +* `UNKNOWN` (value: `"Unknown"`) + +* `SDR` (value: `"SDR"`) + +* `HDR10` (value: `"HDR10"`) + +* `HLG` (value: `"HLG"`) + +* `DOVI` (value: `"DOVI"`) + +* `DOVI_WITH_HDR10` (value: `"DOVIWithHDR10"`) + +* `DOVI_WITH_HLG` (value: `"DOVIWithHLG"`) + +* `DOVI_WITH_SDR` (value: `"DOVIWithSDR"`) + +* `HDR10_PLUS` (value: `"HDR10Plus"`) + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/VideoType.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VideoType.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/VideoType.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VideoType.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VideosApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VideosApi.md new file mode 100644 index 0000000000000..af919f42eaf25 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VideosApi.md @@ -0,0 +1,872 @@ +# VideosApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**deleteAlternateSources**](VideosApi.md#deleteAlternateSources) | **DELETE** /Videos/{itemId}/AlternateSources | Removes alternate video sources. | +| [**getAdditionalPart**](VideosApi.md#getAdditionalPart) | **GET** /Videos/{itemId}/AdditionalParts | Gets additional parts for a video. | +| [**getVideoStream**](VideosApi.md#getVideoStream) | **GET** /Videos/{itemId}/stream | Gets a video stream. | +| [**getVideoStreamByContainer**](VideosApi.md#getVideoStreamByContainer) | **GET** /Videos/{itemId}/stream.{container} | Gets a video stream. | +| [**headVideoStream**](VideosApi.md#headVideoStream) | **HEAD** /Videos/{itemId}/stream | Gets a video stream. | +| [**headVideoStreamByContainer**](VideosApi.md#headVideoStreamByContainer) | **HEAD** /Videos/{itemId}/stream.{container} | Gets a video stream. | +| [**mergeVersions**](VideosApi.md#mergeVersions) | **POST** /Videos/MergeVersions | Merges videos into a single record. | + + + +# **deleteAlternateSources** +> deleteAlternateSources(itemId) + +Removes alternate video sources. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.VideosApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + VideosApi apiInstance = new VideosApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + try { + apiInstance.deleteAlternateSources(itemId); + } catch (ApiException e) { + System.err.println("Exception when calling VideosApi#deleteAlternateSources"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Alternate sources deleted. | - | +| **404** | Video not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getAdditionalPart** +> BaseItemDtoQueryResult getAdditionalPart(itemId, userId) + +Gets additional parts for a video. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.VideosApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + VideosApi apiInstance = new VideosApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + try { + BaseItemDtoQueryResult result = apiInstance.getAdditionalPart(itemId, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling VideosApi#getAdditionalPart"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Additional parts returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getVideoStream** +> File getVideoStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding) + +Gets a video stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.VideosApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + VideosApi apiInstance = new VideosApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String container = "container_example"; // String | The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer maxWidth = 56; // Integer | Optional. The maximum horizontal resolution of the encoded video. + Integer maxHeight = 56; // Integer | Optional. The maximum vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamorphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + try { + File result = apiInstance.getVideoStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling VideosApi#getVideoStream"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **container** | **String**| The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. | [optional] | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **maxWidth** | **Integer**| Optional. The maximum horizontal resolution of the encoded video. | [optional] | +| **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamorphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: video/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Video stream returned. | - | + + +# **getVideoStreamByContainer** +> File getVideoStreamByContainer(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding) + +Gets a video stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.VideosApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + VideosApi apiInstance = new VideosApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String container = "container_example"; // String | The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer maxWidth = 56; // Integer | Optional. The maximum horizontal resolution of the encoded video. + Integer maxHeight = 56; // Integer | Optional. The maximum vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamorphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + try { + File result = apiInstance.getVideoStreamByContainer(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling VideosApi#getVideoStreamByContainer"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **container** | **String**| The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. | | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **maxWidth** | **Integer**| Optional. The maximum horizontal resolution of the encoded video. | [optional] | +| **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamorphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: video/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Video stream returned. | - | + + +# **headVideoStream** +> File headVideoStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding) + +Gets a video stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.VideosApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + VideosApi apiInstance = new VideosApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String container = "container_example"; // String | The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer maxWidth = 56; // Integer | Optional. The maximum horizontal resolution of the encoded video. + Integer maxHeight = 56; // Integer | Optional. The maximum vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamorphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + try { + File result = apiInstance.headVideoStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling VideosApi#headVideoStream"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **container** | **String**| The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. | [optional] | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **maxWidth** | **Integer**| Optional. The maximum horizontal resolution of the encoded video. | [optional] | +| **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamorphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: video/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Video stream returned. | - | + + +# **headVideoStreamByContainer** +> File headVideoStreamByContainer(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding) + +Gets a video stream. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.VideosApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + VideosApi apiInstance = new VideosApi(defaultClient); + UUID itemId = UUID.randomUUID(); // UUID | The item id. + String container = "container_example"; // String | The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. + Boolean _static = true; // Boolean | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. + String params = "params_example"; // String | The streaming parameters. + String tag = "tag_example"; // String | The tag. + String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. + String playSessionId = "playSessionId_example"; // String | The play session id. + String segmentContainer = "segmentContainer_example"; // String | The segment container. + Integer segmentLength = 56; // Integer | The segment length. + Integer minSegments = 56; // Integer | The minimum number of segments. + String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. + String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. + String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. + Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. + Boolean allowVideoStreamCopy = true; // Boolean | Whether or not to allow copying of the video stream url. + Boolean allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url. + Boolean breakOnNonKeyFrames = true; // Boolean | Optional. Whether to break on non key frames. + Integer audioSampleRate = 56; // Integer | Optional. Specify a specific audio sample rate, e.g. 44100. + Integer maxAudioBitDepth = 56; // Integer | Optional. The maximum audio bit depth. + Integer audioBitRate = 56; // Integer | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. + Integer audioChannels = 56; // Integer | Optional. Specify a specific number of audio channels to encode to, e.g. 2. + Integer maxAudioChannels = 56; // Integer | Optional. Specify a maximum number of audio channels to encode to, e.g. 2. + String profile = "profile_example"; // String | Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. + String level = "level_example"; // String | Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. + Float framerate = 3.4F; // Float | Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Float maxFramerate = 3.4F; // Float | Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. + Boolean copyTimestamps = true; // Boolean | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. + Long startTimeTicks = 56L; // Long | Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. + Integer width = 56; // Integer | Optional. The fixed horizontal resolution of the encoded video. + Integer height = 56; // Integer | Optional. The fixed vertical resolution of the encoded video. + Integer maxWidth = 56; // Integer | Optional. The maximum horizontal resolution of the encoded video. + Integer maxHeight = 56; // Integer | Optional. The maximum vertical resolution of the encoded video. + Integer videoBitRate = 56; // Integer | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. + Integer subtitleStreamIndex = 56; // Integer | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. + SubtitleDeliveryMethod subtitleMethod = SubtitleDeliveryMethod.fromValue("Encode"); // SubtitleDeliveryMethod | Optional. Specify the subtitle delivery method. + Integer maxRefFrames = 56; // Integer | Optional. + Integer maxVideoBitDepth = 56; // Integer | Optional. The maximum video bit depth. + Boolean requireAvc = true; // Boolean | Optional. Whether to require avc. + Boolean deInterlace = true; // Boolean | Optional. Whether to deinterlace the video. + Boolean requireNonAnamorphic = true; // Boolean | Optional. Whether to require a non anamorphic stream. + Integer transcodingMaxAudioChannels = 56; // Integer | Optional. The maximum number of audio channels to transcode. + Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. + String liveStreamId = "liveStreamId_example"; // String | The live stream id. + Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. + String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. + String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. + String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. + Integer audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. + Integer videoStreamIndex = 56; // Integer | Optional. The index of the video stream to use. If omitted the first video stream will be used. + EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. + Map streamOptions = new HashMap(); // Map | Optional. The streaming options. + Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding. + try { + File result = apiInstance.headVideoStreamByContainer(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling VideosApi#headVideoStreamByContainer"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **itemId** | **UUID**| The item id. | | +| **container** | **String**| The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. | | +| **_static** | **Boolean**| Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. | [optional] | +| **params** | **String**| The streaming parameters. | [optional] | +| **tag** | **String**| The tag. | [optional] | +| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | +| **playSessionId** | **String**| The play session id. | [optional] | +| **segmentContainer** | **String**| The segment container. | [optional] | +| **segmentLength** | **Integer**| The segment length. | [optional] | +| **minSegments** | **Integer**| The minimum number of segments. | [optional] | +| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [optional] | +| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | +| **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. | [optional] | +| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | +| **allowVideoStreamCopy** | **Boolean**| Whether or not to allow copying of the video stream url. | [optional] | +| **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] | +| **breakOnNonKeyFrames** | **Boolean**| Optional. Whether to break on non key frames. | [optional] | +| **audioSampleRate** | **Integer**| Optional. Specify a specific audio sample rate, e.g. 44100. | [optional] | +| **maxAudioBitDepth** | **Integer**| Optional. The maximum audio bit depth. | [optional] | +| **audioBitRate** | **Integer**| Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. | [optional] | +| **audioChannels** | **Integer**| Optional. Specify a specific number of audio channels to encode to, e.g. 2. | [optional] | +| **maxAudioChannels** | **Integer**| Optional. Specify a maximum number of audio channels to encode to, e.g. 2. | [optional] | +| **profile** | **String**| Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. | [optional] | +| **level** | **String**| Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. | [optional] | +| **framerate** | **Float**| Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **maxFramerate** | **Float**| Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. | [optional] | +| **copyTimestamps** | **Boolean**| Whether or not to copy timestamps when transcoding with an offset. Defaults to false. | [optional] | +| **startTimeTicks** | **Long**| Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. | [optional] | +| **width** | **Integer**| Optional. The fixed horizontal resolution of the encoded video. | [optional] | +| **height** | **Integer**| Optional. The fixed vertical resolution of the encoded video. | [optional] | +| **maxWidth** | **Integer**| Optional. The maximum horizontal resolution of the encoded video. | [optional] | +| **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] | +| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | +| **subtitleStreamIndex** | **Integer**| Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. | [optional] | +| **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] | +| **maxRefFrames** | **Integer**| Optional. | [optional] | +| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | +| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | +| **deInterlace** | **Boolean**| Optional. Whether to deinterlace the video. | [optional] | +| **requireNonAnamorphic** | **Boolean**| Optional. Whether to require a non anamorphic stream. | [optional] | +| **transcodingMaxAudioChannels** | **Integer**| Optional. The maximum number of audio channels to transcode. | [optional] | +| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | +| **liveStreamId** | **String**| The live stream id. | [optional] | +| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [optional] | +| **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. | [optional] | +| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | +| **transcodeReasons** | **String**| Optional. The transcoding reason. | [optional] | +| **audioStreamIndex** | **Integer**| Optional. The index of the audio stream to use. If omitted the first audio stream will be used. | [optional] | +| **videoStreamIndex** | **Integer**| Optional. The index of the video stream to use. If omitted the first video stream will be used. | [optional] | +| **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] | +| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] | +| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] | + +### Return type + +[**File**](File.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: video/* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Video stream returned. | - | + + +# **mergeVersions** +> mergeVersions(ids) + +Merges videos into a single record. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.VideosApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + VideosApi apiInstance = new VideosApi(defaultClient); + List ids = Arrays.asList(); // List | Item id list. This allows multiple, comma delimited. + try { + apiInstance.mergeVersions(ids); + } catch (ApiException e) { + System.err.println("Exception when calling VideosApi#mergeVersions"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **ids** | [**List<UUID>**](UUID.md)| Item id list. This allows multiple, comma delimited. | | + +### Return type + +null (empty response body) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Videos merged. | - | +| **400** | Supply at least 2 video ids. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/VirtualFolderInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VirtualFolderInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/VirtualFolderInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/VirtualFolderInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/WakeOnLanInfo.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/WakeOnLanInfo.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/WakeOnLanInfo.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/WakeOnLanInfo.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/WebSocketMessage.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/WebSocketMessage.md new file mode 100644 index 0000000000000..22697dd752d7c --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/WebSocketMessage.md @@ -0,0 +1,16 @@ + + +# WebSocketMessage + +Represents the possible websocket types + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**data** | [**UserDto**](UserDto.md) | Class UserDto. | [optional] | +|**messageId** | **UUID** | Gets or sets the message id. | [optional] | +|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] | + + + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/XbmcMetadataOptions.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/XbmcMetadataOptions.md similarity index 100% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.10.3/docs/XbmcMetadataOptions.md rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/XbmcMetadataOptions.md diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/YearsApi.md b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/YearsApi.md new file mode 100644 index 0000000000000..d58f84d0ae537 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/docs/YearsApi.md @@ -0,0 +1,179 @@ +# YearsApi + +All URIs are relative to *http://localhost* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getYear**](YearsApi.md#getYear) | **GET** /Years/{year} | Gets a year. | +| [**getYears**](YearsApi.md#getYears) | **GET** /Years | Get years. | + + + +# **getYear** +> BaseItemDto getYear(year, userId) + +Gets a year. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.YearsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + YearsApi apiInstance = new YearsApi(defaultClient); + Integer year = 56; // Integer | The year. + UUID userId = UUID.randomUUID(); // UUID | Optional. Filter by user id, and attach user data. + try { + BaseItemDto result = apiInstance.getYear(year, userId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling YearsApi#getYear"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **year** | **Integer**| The year. | | +| **userId** | **UUID**| Optional. Filter by user id, and attach user data. | [optional] | + +### Return type + +[**BaseItemDto**](BaseItemDto.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Year returned. | - | +| **404** | Year not found. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + + +# **getYears** +> BaseItemDtoQueryResult getYears(startIndex, limit, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, mediaTypes, sortBy, enableUserData, imageTypeLimit, enableImageTypes, userId, recursive, enableImages) + +Get years. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.YearsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost"); + + // Configure API key authorization: CustomAuthentication + ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); + CustomAuthentication.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //CustomAuthentication.setApiKeyPrefix("Token"); + + YearsApi apiInstance = new YearsApi(defaultClient); + Integer startIndex = 56; // Integer | Skips over a given number of items within the results. Use for paging. + Integer limit = 56; // Integer | Optional. The maximum number of records to return. + List sortOrder = Arrays.asList(); // List | Sort Order - Ascending,Descending. + UUID parentId = UUID.randomUUID(); // UUID | Specify this to localize the search to a specific item or folder. Omit to use the root. + List fields = Arrays.asList(); // List | Optional. Specify additional fields of information to return in the output. + List excludeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited. + List includeItemTypes = Arrays.asList(); // List | Optional. If specified, results will be included based on item type. This allows multiple, comma delimited. + List mediaTypes = Arrays.asList(); // List | Optional. Filter by MediaType. Allows multiple, comma delimited. + List sortBy = Arrays.asList(); // List | Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. + Boolean enableUserData = true; // Boolean | Optional. Include user data. + Integer imageTypeLimit = 56; // Integer | Optional. The max number of images to return, per image type. + List enableImageTypes = Arrays.asList(); // List | Optional. The image types to include in the output. + UUID userId = UUID.randomUUID(); // UUID | User Id. + Boolean recursive = true; // Boolean | Search recursively. + Boolean enableImages = true; // Boolean | Optional. Include image information in output. + try { + BaseItemDtoQueryResult result = apiInstance.getYears(startIndex, limit, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, mediaTypes, sortBy, enableUserData, imageTypeLimit, enableImageTypes, userId, recursive, enableImages); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling YearsApi#getYears"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **startIndex** | **Integer**| Skips over a given number of items within the results. Use for paging. | [optional] | +| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | +| **sortOrder** | [**List<SortOrder>**](SortOrder.md)| Sort Order - Ascending,Descending. | [optional] | +| **parentId** | **UUID**| Specify this to localize the search to a specific item or folder. Omit to use the root. | [optional] | +| **fields** | [**List<ItemFields>**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | +| **excludeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited. | [optional] | +| **includeItemTypes** | [**List<BaseItemKind>**](BaseItemKind.md)| Optional. If specified, results will be included based on item type. This allows multiple, comma delimited. | [optional] | +| **mediaTypes** | [**List<MediaType>**](MediaType.md)| Optional. Filter by MediaType. Allows multiple, comma delimited. | [optional] | +| **sortBy** | [**List<ItemSortBy>**](ItemSortBy.md)| Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. | [optional] | +| **enableUserData** | **Boolean**| Optional. Include user data. | [optional] | +| **imageTypeLimit** | **Integer**| Optional. The max number of images to return, per image type. | [optional] | +| **enableImageTypes** | [**List<ImageType>**](ImageType.md)| Optional. The image types to include in the output. | [optional] | +| **userId** | **UUID**| User Id. | [optional] | +| **recursive** | **Boolean**| Search recursively. | [optional] [default to true] | +| **enableImages** | **Boolean**| Optional. Include image information in output. | [optional] [default to true] | + +### Return type + +[**BaseItemDtoQueryResult**](BaseItemDtoQueryResult.md) + +### Authorization + +[CustomAuthentication](../README.md#CustomAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Year query returned. | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | + diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ActivityLogApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ActivityLogApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ActivityLogApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ActivityLogApi.java index 36fd7ce0ccabe..1ce0d18b260c9 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ActivityLogApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ActivityLogApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ApiKeyApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ApiKeyApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ApiKeyApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ApiKeyApi.java index 5492feda972cc..493f781006605 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ApiKeyApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ApiKeyApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ArtistsApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ArtistsApi.java similarity index 91% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ArtistsApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ArtistsApi.java index e99b0c9c38adc..a448dde453670 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ArtistsApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ArtistsApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -33,6 +33,8 @@ import org.openapitools.client.model.ImageType; import org.openapitools.client.model.ItemFields; import org.openapitools.client.model.ItemFilter; +import org.openapitools.client.model.ItemSortBy; +import org.openapitools.client.model.MediaType; import org.openapitools.client.model.SortOrder; import java.util.UUID; @@ -125,7 +127,7 @@ public void setCustomBaseUrl(String customBaseUrl) { 403 Forbidden - */ - public okhttp3.Call getAlbumArtistsCall(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getAlbumArtistsCall(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -300,7 +302,7 @@ public okhttp3.Call getAlbumArtistsCall(Double minCommunityRating, Integer start } @SuppressWarnings("rawtypes") - private okhttp3.Call getAlbumArtistsValidateBeforeCall(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getAlbumArtistsValidateBeforeCall(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { return getAlbumArtistsCall(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, _callback); } @@ -351,7 +353,7 @@ private okhttp3.Call getAlbumArtistsValidateBeforeCall(Double minCommunityRating 403 Forbidden - */ - public BaseItemDtoQueryResult getAlbumArtists(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { + public BaseItemDtoQueryResult getAlbumArtists(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { ApiResponse localVarResp = getAlbumArtistsWithHttpInfo(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount); return localVarResp.getData(); } @@ -402,7 +404,7 @@ public BaseItemDtoQueryResult getAlbumArtists(Double minCommunityRating, Integer 403 Forbidden - */ - public ApiResponse getAlbumArtistsWithHttpInfo(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { + public ApiResponse getAlbumArtistsWithHttpInfo(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { okhttp3.Call localVarCall = getAlbumArtistsValidateBeforeCall(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); @@ -455,7 +457,7 @@ public ApiResponse getAlbumArtistsWithHttpInfo(Double mi 403 Forbidden - */ - public okhttp3.Call getAlbumArtistsAsync(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getAlbumArtistsAsync(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getAlbumArtistsValidateBeforeCall(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, _callback); Type localVarReturnType = new TypeToken(){}.getType(); @@ -653,7 +655,7 @@ public okhttp3.Call getArtistByNameAsync(String name, UUID userId, final ApiCall 403 Forbidden - */ - public okhttp3.Call getArtistsCall(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getArtistsCall(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -828,7 +830,7 @@ public okhttp3.Call getArtistsCall(Double minCommunityRating, Integer startIndex } @SuppressWarnings("rawtypes") - private okhttp3.Call getArtistsValidateBeforeCall(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getArtistsValidateBeforeCall(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { return getArtistsCall(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, _callback); } @@ -879,7 +881,7 @@ private okhttp3.Call getArtistsValidateBeforeCall(Double minCommunityRating, Int 403 Forbidden - */ - public BaseItemDtoQueryResult getArtists(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { + public BaseItemDtoQueryResult getArtists(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { ApiResponse localVarResp = getArtistsWithHttpInfo(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount); return localVarResp.getData(); } @@ -930,7 +932,7 @@ public BaseItemDtoQueryResult getArtists(Double minCommunityRating, Integer star 403 Forbidden - */ - public ApiResponse getArtistsWithHttpInfo(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { + public ApiResponse getArtistsWithHttpInfo(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { okhttp3.Call localVarCall = getArtistsValidateBeforeCall(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); @@ -983,7 +985,7 @@ public ApiResponse getArtistsWithHttpInfo(Double minComm 403 Forbidden - */ - public okhttp3.Call getArtistsAsync(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getArtistsAsync(Double minCommunityRating, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List genres, List genreIds, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List studioIds, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getArtistsValidateBeforeCall(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, _callback); Type localVarReturnType = new TypeToken(){}.getType(); diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/AudioApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/AudioApi.java similarity index 94% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/AudioApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/AudioApi.java index 22d705d880e43..e2beb10fd3ce9 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/AudioApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/AudioApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -89,7 +89,7 @@ public void setCustomBaseUrl(String customBaseUrl) { * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -119,13 +119,14 @@ public void setCustomBaseUrl(String customBaseUrl) { * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -136,7 +137,7 @@ public void setCustomBaseUrl(String customBaseUrl) { 200 Audio stream returned. - */ - public okhttp3.Call getAudioStreamCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getAudioStreamCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -354,6 +355,10 @@ public okhttp3.Call getAudioStreamCall(UUID itemId, String container, Boolean _s localVarQueryParams.addAll(localVarApiClient.parameterToPair("streamOptions", streamOptions)); } + if (enableAudioVbrEncoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAudioVbrEncoding", enableAudioVbrEncoding)); + } + final String[] localVarAccepts = { "audio/*" }; @@ -374,13 +379,13 @@ public okhttp3.Call getAudioStreamCall(UUID itemId, String container, Boolean _s } @SuppressWarnings("rawtypes") - private okhttp3.Call getAudioStreamValidateBeforeCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getAudioStreamValidateBeforeCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getAudioStream(Async)"); } - return getAudioStreamCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + return getAudioStreamCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, _callback); } @@ -399,7 +404,7 @@ private okhttp3.Call getAudioStreamValidateBeforeCall(UUID itemId, String contai * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -429,13 +434,14 @@ private okhttp3.Call getAudioStreamValidateBeforeCall(UUID itemId, String contai * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -445,8 +451,8 @@ private okhttp3.Call getAudioStreamValidateBeforeCall(UUID itemId, String contai 200 Audio stream returned. - */ - public File getAudioStream(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - ApiResponse localVarResp = getAudioStreamWithHttpInfo(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions); + public File getAudioStream(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding) throws ApiException { + ApiResponse localVarResp = getAudioStreamWithHttpInfo(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); return localVarResp.getData(); } @@ -465,7 +471,7 @@ public File getAudioStream(UUID itemId, String container, Boolean _static, Strin * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -495,13 +501,14 @@ public File getAudioStream(UUID itemId, String container, Boolean _static, Strin * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -511,8 +518,8 @@ public File getAudioStream(UUID itemId, String container, Boolean _static, Strin 200 Audio stream returned. - */ - public ApiResponse getAudioStreamWithHttpInfo(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - okhttp3.Call localVarCall = getAudioStreamValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, null); + public ApiResponse getAudioStreamWithHttpInfo(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding) throws ApiException { + okhttp3.Call localVarCall = getAudioStreamValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -532,7 +539,7 @@ public ApiResponse getAudioStreamWithHttpInfo(UUID itemId, String containe * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -562,13 +569,14 @@ public ApiResponse getAudioStreamWithHttpInfo(UUID itemId, String containe * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -579,9 +587,9 @@ public ApiResponse getAudioStreamWithHttpInfo(UUID itemId, String containe 200 Audio stream returned. - */ - public okhttp3.Call getAudioStreamAsync(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getAudioStreamAsync(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getAudioStreamValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + okhttp3.Call localVarCall = getAudioStreamValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -596,11 +604,11 @@ public okhttp3.Call getAudioStreamAsync(UUID itemId, String container, Boolean _ * @param deviceProfileId Optional. The dlna device profile id to utilize. (optional) * @param playSessionId The play session id. (optional) * @param segmentContainer The segment container. (optional) - * @param segmentLength The segment lenght. (optional) + * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -630,13 +638,14 @@ public okhttp3.Call getAudioStreamAsync(UUID itemId, String container, Boolean _ * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -647,7 +656,7 @@ public okhttp3.Call getAudioStreamAsync(UUID itemId, String container, Boolean _ 200 Audio stream returned. - */ - public okhttp3.Call getAudioStreamByContainerCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getAudioStreamByContainerCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -862,6 +871,10 @@ public okhttp3.Call getAudioStreamByContainerCall(UUID itemId, String container, localVarQueryParams.addAll(localVarApiClient.parameterToPair("streamOptions", streamOptions)); } + if (enableAudioVbrEncoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAudioVbrEncoding", enableAudioVbrEncoding)); + } + final String[] localVarAccepts = { "audio/*" }; @@ -882,7 +895,7 @@ public okhttp3.Call getAudioStreamByContainerCall(UUID itemId, String container, } @SuppressWarnings("rawtypes") - private okhttp3.Call getAudioStreamByContainerValidateBeforeCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getAudioStreamByContainerValidateBeforeCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getAudioStreamByContainer(Async)"); @@ -893,7 +906,7 @@ private okhttp3.Call getAudioStreamByContainerValidateBeforeCall(UUID itemId, St throw new ApiException("Missing the required parameter 'container' when calling getAudioStreamByContainer(Async)"); } - return getAudioStreamByContainerCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + return getAudioStreamByContainerCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, _callback); } @@ -908,11 +921,11 @@ private okhttp3.Call getAudioStreamByContainerValidateBeforeCall(UUID itemId, St * @param deviceProfileId Optional. The dlna device profile id to utilize. (optional) * @param playSessionId The play session id. (optional) * @param segmentContainer The segment container. (optional) - * @param segmentLength The segment lenght. (optional) + * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -942,13 +955,14 @@ private okhttp3.Call getAudioStreamByContainerValidateBeforeCall(UUID itemId, St * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -958,8 +972,8 @@ private okhttp3.Call getAudioStreamByContainerValidateBeforeCall(UUID itemId, St 200 Audio stream returned. - */ - public File getAudioStreamByContainer(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - ApiResponse localVarResp = getAudioStreamByContainerWithHttpInfo(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions); + public File getAudioStreamByContainer(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding) throws ApiException { + ApiResponse localVarResp = getAudioStreamByContainerWithHttpInfo(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); return localVarResp.getData(); } @@ -974,11 +988,11 @@ public File getAudioStreamByContainer(UUID itemId, String container, Boolean _st * @param deviceProfileId Optional. The dlna device profile id to utilize. (optional) * @param playSessionId The play session id. (optional) * @param segmentContainer The segment container. (optional) - * @param segmentLength The segment lenght. (optional) + * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1008,13 +1022,14 @@ public File getAudioStreamByContainer(UUID itemId, String container, Boolean _st * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1024,8 +1039,8 @@ public File getAudioStreamByContainer(UUID itemId, String container, Boolean _st 200 Audio stream returned. - */ - public ApiResponse getAudioStreamByContainerWithHttpInfo(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - okhttp3.Call localVarCall = getAudioStreamByContainerValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, null); + public ApiResponse getAudioStreamByContainerWithHttpInfo(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding) throws ApiException { + okhttp3.Call localVarCall = getAudioStreamByContainerValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -1041,11 +1056,11 @@ public ApiResponse getAudioStreamByContainerWithHttpInfo(UUID itemId, Stri * @param deviceProfileId Optional. The dlna device profile id to utilize. (optional) * @param playSessionId The play session id. (optional) * @param segmentContainer The segment container. (optional) - * @param segmentLength The segment lenght. (optional) + * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1075,13 +1090,14 @@ public ApiResponse getAudioStreamByContainerWithHttpInfo(UUID itemId, Stri * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -1092,9 +1108,9 @@ public ApiResponse getAudioStreamByContainerWithHttpInfo(UUID itemId, Stri 200 Audio stream returned. - */ - public okhttp3.Call getAudioStreamByContainerAsync(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getAudioStreamByContainerAsync(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getAudioStreamByContainerValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + okhttp3.Call localVarCall = getAudioStreamByContainerValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -1113,7 +1129,7 @@ public okhttp3.Call getAudioStreamByContainerAsync(UUID itemId, String container * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1143,13 +1159,14 @@ public okhttp3.Call getAudioStreamByContainerAsync(UUID itemId, String container * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -1160,7 +1177,7 @@ public okhttp3.Call getAudioStreamByContainerAsync(UUID itemId, String container 200 Audio stream returned. - */ - public okhttp3.Call headAudioStreamCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headAudioStreamCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1378,6 +1395,10 @@ public okhttp3.Call headAudioStreamCall(UUID itemId, String container, Boolean _ localVarQueryParams.addAll(localVarApiClient.parameterToPair("streamOptions", streamOptions)); } + if (enableAudioVbrEncoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAudioVbrEncoding", enableAudioVbrEncoding)); + } + final String[] localVarAccepts = { "audio/*" }; @@ -1398,13 +1419,13 @@ public okhttp3.Call headAudioStreamCall(UUID itemId, String container, Boolean _ } @SuppressWarnings("rawtypes") - private okhttp3.Call headAudioStreamValidateBeforeCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + private okhttp3.Call headAudioStreamValidateBeforeCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling headAudioStream(Async)"); } - return headAudioStreamCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + return headAudioStreamCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, _callback); } @@ -1423,7 +1444,7 @@ private okhttp3.Call headAudioStreamValidateBeforeCall(UUID itemId, String conta * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1453,13 +1474,14 @@ private okhttp3.Call headAudioStreamValidateBeforeCall(UUID itemId, String conta * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1469,8 +1491,8 @@ private okhttp3.Call headAudioStreamValidateBeforeCall(UUID itemId, String conta 200 Audio stream returned. - */ - public File headAudioStream(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - ApiResponse localVarResp = headAudioStreamWithHttpInfo(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions); + public File headAudioStream(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding) throws ApiException { + ApiResponse localVarResp = headAudioStreamWithHttpInfo(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); return localVarResp.getData(); } @@ -1489,7 +1511,7 @@ public File headAudioStream(UUID itemId, String container, Boolean _static, Stri * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1519,13 +1541,14 @@ public File headAudioStream(UUID itemId, String container, Boolean _static, Stri * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1535,8 +1558,8 @@ public File headAudioStream(UUID itemId, String container, Boolean _static, Stri 200 Audio stream returned. - */ - public ApiResponse headAudioStreamWithHttpInfo(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - okhttp3.Call localVarCall = headAudioStreamValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, null); + public ApiResponse headAudioStreamWithHttpInfo(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding) throws ApiException { + okhttp3.Call localVarCall = headAudioStreamValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -1556,7 +1579,7 @@ public ApiResponse headAudioStreamWithHttpInfo(UUID itemId, String contain * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1586,13 +1609,14 @@ public ApiResponse headAudioStreamWithHttpInfo(UUID itemId, String contain * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -1603,9 +1627,9 @@ public ApiResponse headAudioStreamWithHttpInfo(UUID itemId, String contain 200 Audio stream returned. - */ - public okhttp3.Call headAudioStreamAsync(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headAudioStreamAsync(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headAudioStreamValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + okhttp3.Call localVarCall = headAudioStreamValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -1620,11 +1644,11 @@ public okhttp3.Call headAudioStreamAsync(UUID itemId, String container, Boolean * @param deviceProfileId Optional. The dlna device profile id to utilize. (optional) * @param playSessionId The play session id. (optional) * @param segmentContainer The segment container. (optional) - * @param segmentLength The segment lenght. (optional) + * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1654,13 +1678,14 @@ public okhttp3.Call headAudioStreamAsync(UUID itemId, String container, Boolean * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -1671,7 +1696,7 @@ public okhttp3.Call headAudioStreamAsync(UUID itemId, String container, Boolean 200 Audio stream returned. - */ - public okhttp3.Call headAudioStreamByContainerCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headAudioStreamByContainerCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1886,6 +1911,10 @@ public okhttp3.Call headAudioStreamByContainerCall(UUID itemId, String container localVarQueryParams.addAll(localVarApiClient.parameterToPair("streamOptions", streamOptions)); } + if (enableAudioVbrEncoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAudioVbrEncoding", enableAudioVbrEncoding)); + } + final String[] localVarAccepts = { "audio/*" }; @@ -1906,7 +1935,7 @@ public okhttp3.Call headAudioStreamByContainerCall(UUID itemId, String container } @SuppressWarnings("rawtypes") - private okhttp3.Call headAudioStreamByContainerValidateBeforeCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + private okhttp3.Call headAudioStreamByContainerValidateBeforeCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling headAudioStreamByContainer(Async)"); @@ -1917,7 +1946,7 @@ private okhttp3.Call headAudioStreamByContainerValidateBeforeCall(UUID itemId, S throw new ApiException("Missing the required parameter 'container' when calling headAudioStreamByContainer(Async)"); } - return headAudioStreamByContainerCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + return headAudioStreamByContainerCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, _callback); } @@ -1932,11 +1961,11 @@ private okhttp3.Call headAudioStreamByContainerValidateBeforeCall(UUID itemId, S * @param deviceProfileId Optional. The dlna device profile id to utilize. (optional) * @param playSessionId The play session id. (optional) * @param segmentContainer The segment container. (optional) - * @param segmentLength The segment lenght. (optional) + * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1966,13 +1995,14 @@ private okhttp3.Call headAudioStreamByContainerValidateBeforeCall(UUID itemId, S * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1982,8 +2012,8 @@ private okhttp3.Call headAudioStreamByContainerValidateBeforeCall(UUID itemId, S 200 Audio stream returned. - */ - public File headAudioStreamByContainer(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - ApiResponse localVarResp = headAudioStreamByContainerWithHttpInfo(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions); + public File headAudioStreamByContainer(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding) throws ApiException { + ApiResponse localVarResp = headAudioStreamByContainerWithHttpInfo(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); return localVarResp.getData(); } @@ -1998,11 +2028,11 @@ public File headAudioStreamByContainer(UUID itemId, String container, Boolean _s * @param deviceProfileId Optional. The dlna device profile id to utilize. (optional) * @param playSessionId The play session id. (optional) * @param segmentContainer The segment container. (optional) - * @param segmentLength The segment lenght. (optional) + * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -2032,13 +2062,14 @@ public File headAudioStreamByContainer(UUID itemId, String container, Boolean _s * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2048,8 +2079,8 @@ public File headAudioStreamByContainer(UUID itemId, String container, Boolean _s 200 Audio stream returned. - */ - public ApiResponse headAudioStreamByContainerWithHttpInfo(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - okhttp3.Call localVarCall = headAudioStreamByContainerValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, null); + public ApiResponse headAudioStreamByContainerWithHttpInfo(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding) throws ApiException { + okhttp3.Call localVarCall = headAudioStreamByContainerValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -2065,11 +2096,11 @@ public ApiResponse headAudioStreamByContainerWithHttpInfo(UUID itemId, Str * @param deviceProfileId Optional. The dlna device profile id to utilize. (optional) * @param playSessionId The play session id. (optional) * @param segmentContainer The segment container. (optional) - * @param segmentLength The segment lenght. (optional) + * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -2099,13 +2130,14 @@ public ApiResponse headAudioStreamByContainerWithHttpInfo(UUID itemId, Str * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -2116,9 +2148,9 @@ public ApiResponse headAudioStreamByContainerWithHttpInfo(UUID itemId, Str 200 Audio stream returned. - */ - public okhttp3.Call headAudioStreamByContainerAsync(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headAudioStreamByContainerAsync(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headAudioStreamByContainerValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + okhttp3.Call localVarCall = headAudioStreamByContainerValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/BrandingApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/BrandingApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/BrandingApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/BrandingApi.java index 324fc93d83668..20fcb6ae9210c 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/BrandingApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/BrandingApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ChannelsApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ChannelsApi.java similarity index 98% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ChannelsApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ChannelsApi.java index af6dfb548d19d..082233dd393d8 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ChannelsApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ChannelsApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -31,6 +31,7 @@ import org.openapitools.client.model.ChannelFeatures; import org.openapitools.client.model.ItemFields; import org.openapitools.client.model.ItemFilter; +import org.openapitools.client.model.ItemSortBy; import org.openapitools.client.model.SortOrder; import java.util.UUID; @@ -364,7 +365,7 @@ public okhttp3.Call getChannelFeaturesAsync(UUID channelId, final ApiCallback 403 Forbidden - */ - public okhttp3.Call getChannelItemsCall(UUID channelId, UUID folderId, UUID userId, Integer startIndex, Integer limit, List sortOrder, List filters, List sortBy, List fields, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getChannelItemsCall(UUID channelId, UUID folderId, UUID userId, Integer startIndex, Integer limit, List sortOrder, List filters, List sortBy, List fields, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -444,7 +445,7 @@ public okhttp3.Call getChannelItemsCall(UUID channelId, UUID folderId, UUID user } @SuppressWarnings("rawtypes") - private okhttp3.Call getChannelItemsValidateBeforeCall(UUID channelId, UUID folderId, UUID userId, Integer startIndex, Integer limit, List sortOrder, List filters, List sortBy, List fields, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getChannelItemsValidateBeforeCall(UUID channelId, UUID folderId, UUID userId, Integer startIndex, Integer limit, List sortOrder, List filters, List sortBy, List fields, final ApiCallback _callback) throws ApiException { // verify the required parameter 'channelId' is set if (channelId == null) { throw new ApiException("Missing the required parameter 'channelId' when calling getChannelItems(Async)"); @@ -477,7 +478,7 @@ private okhttp3.Call getChannelItemsValidateBeforeCall(UUID channelId, UUID fold 403 Forbidden - */ - public BaseItemDtoQueryResult getChannelItems(UUID channelId, UUID folderId, UUID userId, Integer startIndex, Integer limit, List sortOrder, List filters, List sortBy, List fields) throws ApiException { + public BaseItemDtoQueryResult getChannelItems(UUID channelId, UUID folderId, UUID userId, Integer startIndex, Integer limit, List sortOrder, List filters, List sortBy, List fields) throws ApiException { ApiResponse localVarResp = getChannelItemsWithHttpInfo(channelId, folderId, userId, startIndex, limit, sortOrder, filters, sortBy, fields); return localVarResp.getData(); } @@ -505,7 +506,7 @@ public BaseItemDtoQueryResult getChannelItems(UUID channelId, UUID folderId, UUI 403 Forbidden - */ - public ApiResponse getChannelItemsWithHttpInfo(UUID channelId, UUID folderId, UUID userId, Integer startIndex, Integer limit, List sortOrder, List filters, List sortBy, List fields) throws ApiException { + public ApiResponse getChannelItemsWithHttpInfo(UUID channelId, UUID folderId, UUID userId, Integer startIndex, Integer limit, List sortOrder, List filters, List sortBy, List fields) throws ApiException { okhttp3.Call localVarCall = getChannelItemsValidateBeforeCall(channelId, folderId, userId, startIndex, limit, sortOrder, filters, sortBy, fields, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); @@ -535,7 +536,7 @@ public ApiResponse getChannelItemsWithHttpInfo(UUID chan 403 Forbidden - */ - public okhttp3.Call getChannelItemsAsync(UUID channelId, UUID folderId, UUID userId, Integer startIndex, Integer limit, List sortOrder, List filters, List sortBy, List fields, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getChannelItemsAsync(UUID channelId, UUID folderId, UUID userId, Integer startIndex, Integer limit, List sortOrder, List filters, List sortBy, List fields, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getChannelItemsValidateBeforeCall(channelId, folderId, userId, startIndex, limit, sortOrder, filters, sortBy, fields, _callback); Type localVarReturnType = new TypeToken(){}.getType(); diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ClientLogApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ClientLogApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ClientLogApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ClientLogApi.java index e1e0b0fe196da..517d35e44cab1 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ClientLogApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ClientLogApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/CollectionApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/CollectionApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/CollectionApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/CollectionApi.java index 838fb831cde55..c4a9ec8fd3755 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/CollectionApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/CollectionApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ConfigurationApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ConfigurationApi.java similarity index 83% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ConfigurationApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ConfigurationApi.java index 9845e07679fcd..0a9dfe092c2e0 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ConfigurationApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ConfigurationApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -28,7 +28,6 @@ import java.io.File; -import org.openapitools.client.model.MediaEncoderPathDto; import org.openapitools.client.model.MetadataOptions; import org.openapitools.client.model.ServerConfiguration; @@ -596,147 +595,6 @@ public okhttp3.Call updateConfigurationAsync(ServerConfiguration serverConfigura localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } - /** - * Build call for updateMediaEncoderPath - * @param mediaEncoderPathDto Media encoder path form body. (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
204 Media encoder path updated. -
401 Unauthorized -
403 Forbidden -
- * @deprecated - */ - @Deprecated - public okhttp3.Call updateMediaEncoderPathCall(MediaEncoderPathDto mediaEncoderPathDto, final ApiCallback _callback) throws ApiException { - String basePath = null; - // Operation Servers - String[] localBasePaths = new String[] { }; - - // Determine Base Path to Use - if (localCustomBaseUrl != null){ - basePath = localCustomBaseUrl; - } else if ( localBasePaths.length > 0 ) { - basePath = localBasePaths[localHostIndex]; - } else { - basePath = null; - } - - Object localVarPostBody = mediaEncoderPathDto; - - // create path and map variables - String localVarPath = "/System/MediaEncoder/Path"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - - final String[] localVarAccepts = { - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - "application/json", - "text/json", - "application/*+json" - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - if (localVarContentType != null) { - localVarHeaderParams.put("Content-Type", localVarContentType); - } - - String[] localVarAuthNames = new String[] { "CustomAuthentication" }; - return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @Deprecated - @SuppressWarnings("rawtypes") - private okhttp3.Call updateMediaEncoderPathValidateBeforeCall(MediaEncoderPathDto mediaEncoderPathDto, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'mediaEncoderPathDto' is set - if (mediaEncoderPathDto == null) { - throw new ApiException("Missing the required parameter 'mediaEncoderPathDto' when calling updateMediaEncoderPath(Async)"); - } - - return updateMediaEncoderPathCall(mediaEncoderPathDto, _callback); - - } - - /** - * Updates the path to the media encoder. - * - * @param mediaEncoderPathDto Media encoder path form body. (required) - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
204 Media encoder path updated. -
401 Unauthorized -
403 Forbidden -
- * @deprecated - */ - @Deprecated - public void updateMediaEncoderPath(MediaEncoderPathDto mediaEncoderPathDto) throws ApiException { - updateMediaEncoderPathWithHttpInfo(mediaEncoderPathDto); - } - - /** - * Updates the path to the media encoder. - * - * @param mediaEncoderPathDto Media encoder path form body. (required) - * @return ApiResponse<Void> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
204 Media encoder path updated. -
401 Unauthorized -
403 Forbidden -
- * @deprecated - */ - @Deprecated - public ApiResponse updateMediaEncoderPathWithHttpInfo(MediaEncoderPathDto mediaEncoderPathDto) throws ApiException { - okhttp3.Call localVarCall = updateMediaEncoderPathValidateBeforeCall(mediaEncoderPathDto, null); - return localVarApiClient.execute(localVarCall); - } - - /** - * Updates the path to the media encoder. (asynchronously) - * - * @param mediaEncoderPathDto Media encoder path form body. (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
204 Media encoder path updated. -
401 Unauthorized -
403 Forbidden -
- * @deprecated - */ - @Deprecated - public okhttp3.Call updateMediaEncoderPathAsync(MediaEncoderPathDto mediaEncoderPathDto, final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = updateMediaEncoderPathValidateBeforeCall(mediaEncoderPathDto, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); - return localVarCall; - } /** * Build call for updateNamedConfiguration * @param key Configuration key. (required) diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/DashboardApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/DashboardApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/DashboardApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/DashboardApi.java index 18d606728111d..5afd35e0c6f4a 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/DashboardApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/DashboardApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/DevicesApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/DevicesApi.java similarity index 91% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/DevicesApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/DevicesApi.java index f54bdc6224316..b42a54729a713 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/DevicesApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/DevicesApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -27,9 +27,8 @@ import java.io.IOException; -import org.openapitools.client.model.DeviceInfo; -import org.openapitools.client.model.DeviceInfoQueryResult; -import org.openapitools.client.model.DeviceOptions; +import org.openapitools.client.model.DeviceInfoDto; +import org.openapitools.client.model.DeviceInfoDtoQueryResult; import org.openapitools.client.model.DeviceOptionsDto; import org.openapitools.client.model.ProblemDetails; import java.util.UUID; @@ -298,7 +297,7 @@ private okhttp3.Call getDeviceInfoValidateBeforeCall(String id, final ApiCallbac * Get info for a device. * * @param id Device Id. (required) - * @return DeviceInfo + * @return DeviceInfoDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -310,8 +309,8 @@ private okhttp3.Call getDeviceInfoValidateBeforeCall(String id, final ApiCallbac
403 Forbidden -
*/ - public DeviceInfo getDeviceInfo(String id) throws ApiException { - ApiResponse localVarResp = getDeviceInfoWithHttpInfo(id); + public DeviceInfoDto getDeviceInfo(String id) throws ApiException { + ApiResponse localVarResp = getDeviceInfoWithHttpInfo(id); return localVarResp.getData(); } @@ -319,7 +318,7 @@ public DeviceInfo getDeviceInfo(String id) throws ApiException { * Get info for a device. * * @param id Device Id. (required) - * @return ApiResponse<DeviceInfo> + * @return ApiResponse<DeviceInfoDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -331,9 +330,9 @@ public DeviceInfo getDeviceInfo(String id) throws ApiException {
403 Forbidden -
*/ - public ApiResponse getDeviceInfoWithHttpInfo(String id) throws ApiException { + public ApiResponse getDeviceInfoWithHttpInfo(String id) throws ApiException { okhttp3.Call localVarCall = getDeviceInfoValidateBeforeCall(id, null); - Type localVarReturnType = new TypeToken(){}.getType(); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -354,10 +353,10 @@ public ApiResponse getDeviceInfoWithHttpInfo(String id) throws ApiEx 403 Forbidden - */ - public okhttp3.Call getDeviceInfoAsync(String id, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getDeviceInfoAsync(String id, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getDeviceInfoValidateBeforeCall(id, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -442,7 +441,7 @@ private okhttp3.Call getDeviceOptionsValidateBeforeCall(String id, final ApiCall * Get options for a device. * * @param id Device Id. (required) - * @return DeviceOptions + * @return DeviceOptionsDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -454,8 +453,8 @@ private okhttp3.Call getDeviceOptionsValidateBeforeCall(String id, final ApiCall
403 Forbidden -
*/ - public DeviceOptions getDeviceOptions(String id) throws ApiException { - ApiResponse localVarResp = getDeviceOptionsWithHttpInfo(id); + public DeviceOptionsDto getDeviceOptions(String id) throws ApiException { + ApiResponse localVarResp = getDeviceOptionsWithHttpInfo(id); return localVarResp.getData(); } @@ -463,7 +462,7 @@ public DeviceOptions getDeviceOptions(String id) throws ApiException { * Get options for a device. * * @param id Device Id. (required) - * @return ApiResponse<DeviceOptions> + * @return ApiResponse<DeviceOptionsDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -475,9 +474,9 @@ public DeviceOptions getDeviceOptions(String id) throws ApiException {
403 Forbidden -
*/ - public ApiResponse getDeviceOptionsWithHttpInfo(String id) throws ApiException { + public ApiResponse getDeviceOptionsWithHttpInfo(String id) throws ApiException { okhttp3.Call localVarCall = getDeviceOptionsValidateBeforeCall(id, null); - Type localVarReturnType = new TypeToken(){}.getType(); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -498,16 +497,15 @@ public ApiResponse getDeviceOptionsWithHttpInfo(String id) throws 403 Forbidden - */ - public okhttp3.Call getDeviceOptionsAsync(String id, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getDeviceOptionsAsync(String id, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getDeviceOptionsValidateBeforeCall(id, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getDevices - * @param supportsSync Gets or sets a value indicating whether [supports synchronize]. (optional) * @param userId Gets or sets the user identifier. (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -521,7 +519,7 @@ public okhttp3.Call getDeviceOptionsAsync(String id, final ApiCallback 403 Forbidden - */ - public okhttp3.Call getDevicesCall(Boolean supportsSync, UUID userId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getDevicesCall(UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -546,10 +544,6 @@ public okhttp3.Call getDevicesCall(Boolean supportsSync, UUID userId, final ApiC Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); - if (supportsSync != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("supportsSync", supportsSync)); - } - if (userId != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); } @@ -576,17 +570,16 @@ public okhttp3.Call getDevicesCall(Boolean supportsSync, UUID userId, final ApiC } @SuppressWarnings("rawtypes") - private okhttp3.Call getDevicesValidateBeforeCall(Boolean supportsSync, UUID userId, final ApiCallback _callback) throws ApiException { - return getDevicesCall(supportsSync, userId, _callback); + private okhttp3.Call getDevicesValidateBeforeCall(UUID userId, final ApiCallback _callback) throws ApiException { + return getDevicesCall(userId, _callback); } /** * Get Devices. * - * @param supportsSync Gets or sets a value indicating whether [supports synchronize]. (optional) * @param userId Gets or sets the user identifier. (optional) - * @return DeviceInfoQueryResult + * @return DeviceInfoDtoQueryResult * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -597,17 +590,16 @@ private okhttp3.Call getDevicesValidateBeforeCall(Boolean supportsSync, UUID use
403 Forbidden -
*/ - public DeviceInfoQueryResult getDevices(Boolean supportsSync, UUID userId) throws ApiException { - ApiResponse localVarResp = getDevicesWithHttpInfo(supportsSync, userId); + public DeviceInfoDtoQueryResult getDevices(UUID userId) throws ApiException { + ApiResponse localVarResp = getDevicesWithHttpInfo(userId); return localVarResp.getData(); } /** * Get Devices. * - * @param supportsSync Gets or sets a value indicating whether [supports synchronize]. (optional) * @param userId Gets or sets the user identifier. (optional) - * @return ApiResponse<DeviceInfoQueryResult> + * @return ApiResponse<DeviceInfoDtoQueryResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -618,16 +610,15 @@ public DeviceInfoQueryResult getDevices(Boolean supportsSync, UUID userId) throw
403 Forbidden -
*/ - public ApiResponse getDevicesWithHttpInfo(Boolean supportsSync, UUID userId) throws ApiException { - okhttp3.Call localVarCall = getDevicesValidateBeforeCall(supportsSync, userId, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse getDevicesWithHttpInfo(UUID userId) throws ApiException { + okhttp3.Call localVarCall = getDevicesValidateBeforeCall(userId, null); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get Devices. (asynchronously) * - * @param supportsSync Gets or sets a value indicating whether [supports synchronize]. (optional) * @param userId Gets or sets the user identifier. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -641,10 +632,10 @@ public ApiResponse getDevicesWithHttpInfo(Boolean support 403 Forbidden - */ - public okhttp3.Call getDevicesAsync(Boolean supportsSync, UUID userId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getDevicesAsync(UUID userId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getDevicesValidateBeforeCall(supportsSync, userId, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + okhttp3.Call localVarCall = getDevicesValidateBeforeCall(userId, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/DisplayPreferencesApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/DisplayPreferencesApi.java similarity index 87% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/DisplayPreferencesApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/DisplayPreferencesApi.java index f1a6c560d7b2b..68dc3b5c96ce6 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/DisplayPreferencesApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/DisplayPreferencesApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -76,8 +76,8 @@ public void setCustomBaseUrl(String customBaseUrl) { /** * Build call for getDisplayPreferences * @param displayPreferencesId Display preferences id. (required) - * @param userId User id. (required) * @param client Client. (required) + * @param userId User id. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -90,7 +90,7 @@ public void setCustomBaseUrl(String customBaseUrl) { 403 Forbidden - */ - public okhttp3.Call getDisplayPreferencesCall(String displayPreferencesId, UUID userId, String client, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getDisplayPreferencesCall(String displayPreferencesId, String client, UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -146,23 +146,18 @@ public okhttp3.Call getDisplayPreferencesCall(String displayPreferencesId, UUID } @SuppressWarnings("rawtypes") - private okhttp3.Call getDisplayPreferencesValidateBeforeCall(String displayPreferencesId, UUID userId, String client, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getDisplayPreferencesValidateBeforeCall(String displayPreferencesId, String client, UUID userId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'displayPreferencesId' is set if (displayPreferencesId == null) { throw new ApiException("Missing the required parameter 'displayPreferencesId' when calling getDisplayPreferences(Async)"); } - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling getDisplayPreferences(Async)"); - } - // verify the required parameter 'client' is set if (client == null) { throw new ApiException("Missing the required parameter 'client' when calling getDisplayPreferences(Async)"); } - return getDisplayPreferencesCall(displayPreferencesId, userId, client, _callback); + return getDisplayPreferencesCall(displayPreferencesId, client, userId, _callback); } @@ -170,8 +165,8 @@ private okhttp3.Call getDisplayPreferencesValidateBeforeCall(String displayPrefe * Get Display Preferences. * * @param displayPreferencesId Display preferences id. (required) - * @param userId User id. (required) * @param client Client. (required) + * @param userId User id. (optional) * @return DisplayPreferencesDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -183,8 +178,8 @@ private okhttp3.Call getDisplayPreferencesValidateBeforeCall(String displayPrefe 403 Forbidden - */ - public DisplayPreferencesDto getDisplayPreferences(String displayPreferencesId, UUID userId, String client) throws ApiException { - ApiResponse localVarResp = getDisplayPreferencesWithHttpInfo(displayPreferencesId, userId, client); + public DisplayPreferencesDto getDisplayPreferences(String displayPreferencesId, String client, UUID userId) throws ApiException { + ApiResponse localVarResp = getDisplayPreferencesWithHttpInfo(displayPreferencesId, client, userId); return localVarResp.getData(); } @@ -192,8 +187,8 @@ public DisplayPreferencesDto getDisplayPreferences(String displayPreferencesId, * Get Display Preferences. * * @param displayPreferencesId Display preferences id. (required) - * @param userId User id. (required) * @param client Client. (required) + * @param userId User id. (optional) * @return ApiResponse<DisplayPreferencesDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -205,8 +200,8 @@ public DisplayPreferencesDto getDisplayPreferences(String displayPreferencesId, 403 Forbidden - */ - public ApiResponse getDisplayPreferencesWithHttpInfo(String displayPreferencesId, UUID userId, String client) throws ApiException { - okhttp3.Call localVarCall = getDisplayPreferencesValidateBeforeCall(displayPreferencesId, userId, client, null); + public ApiResponse getDisplayPreferencesWithHttpInfo(String displayPreferencesId, String client, UUID userId) throws ApiException { + okhttp3.Call localVarCall = getDisplayPreferencesValidateBeforeCall(displayPreferencesId, client, userId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -215,8 +210,8 @@ public ApiResponse getDisplayPreferencesWithHttpInfo(Stri * Get Display Preferences. (asynchronously) * * @param displayPreferencesId Display preferences id. (required) - * @param userId User id. (required) * @param client Client. (required) + * @param userId User id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -229,9 +224,9 @@ public ApiResponse getDisplayPreferencesWithHttpInfo(Stri 403 Forbidden - */ - public okhttp3.Call getDisplayPreferencesAsync(String displayPreferencesId, UUID userId, String client, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getDisplayPreferencesAsync(String displayPreferencesId, String client, UUID userId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getDisplayPreferencesValidateBeforeCall(displayPreferencesId, userId, client, _callback); + okhttp3.Call localVarCall = getDisplayPreferencesValidateBeforeCall(displayPreferencesId, client, userId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -239,9 +234,9 @@ public okhttp3.Call getDisplayPreferencesAsync(String displayPreferencesId, UUID /** * Build call for updateDisplayPreferences * @param displayPreferencesId Display preferences id. (required) - * @param userId User Id. (required) * @param client Client. (required) * @param displayPreferencesDto New Display Preferences object. (required) + * @param userId User Id. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -254,7 +249,7 @@ public okhttp3.Call getDisplayPreferencesAsync(String displayPreferencesId, UUID 403 Forbidden - */ - public okhttp3.Call updateDisplayPreferencesCall(String displayPreferencesId, UUID userId, String client, DisplayPreferencesDto displayPreferencesDto, final ApiCallback _callback) throws ApiException { + public okhttp3.Call updateDisplayPreferencesCall(String displayPreferencesId, String client, DisplayPreferencesDto displayPreferencesDto, UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -310,17 +305,12 @@ public okhttp3.Call updateDisplayPreferencesCall(String displayPreferencesId, UU } @SuppressWarnings("rawtypes") - private okhttp3.Call updateDisplayPreferencesValidateBeforeCall(String displayPreferencesId, UUID userId, String client, DisplayPreferencesDto displayPreferencesDto, final ApiCallback _callback) throws ApiException { + private okhttp3.Call updateDisplayPreferencesValidateBeforeCall(String displayPreferencesId, String client, DisplayPreferencesDto displayPreferencesDto, UUID userId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'displayPreferencesId' is set if (displayPreferencesId == null) { throw new ApiException("Missing the required parameter 'displayPreferencesId' when calling updateDisplayPreferences(Async)"); } - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling updateDisplayPreferences(Async)"); - } - // verify the required parameter 'client' is set if (client == null) { throw new ApiException("Missing the required parameter 'client' when calling updateDisplayPreferences(Async)"); @@ -331,7 +321,7 @@ private okhttp3.Call updateDisplayPreferencesValidateBeforeCall(String displayPr throw new ApiException("Missing the required parameter 'displayPreferencesDto' when calling updateDisplayPreferences(Async)"); } - return updateDisplayPreferencesCall(displayPreferencesId, userId, client, displayPreferencesDto, _callback); + return updateDisplayPreferencesCall(displayPreferencesId, client, displayPreferencesDto, userId, _callback); } @@ -339,9 +329,9 @@ private okhttp3.Call updateDisplayPreferencesValidateBeforeCall(String displayPr * Update Display Preferences. * * @param displayPreferencesId Display preferences id. (required) - * @param userId User Id. (required) * @param client Client. (required) * @param displayPreferencesDto New Display Preferences object. (required) + * @param userId User Id. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -352,17 +342,17 @@ private okhttp3.Call updateDisplayPreferencesValidateBeforeCall(String displayPr
403 Forbidden -
*/ - public void updateDisplayPreferences(String displayPreferencesId, UUID userId, String client, DisplayPreferencesDto displayPreferencesDto) throws ApiException { - updateDisplayPreferencesWithHttpInfo(displayPreferencesId, userId, client, displayPreferencesDto); + public void updateDisplayPreferences(String displayPreferencesId, String client, DisplayPreferencesDto displayPreferencesDto, UUID userId) throws ApiException { + updateDisplayPreferencesWithHttpInfo(displayPreferencesId, client, displayPreferencesDto, userId); } /** * Update Display Preferences. * * @param displayPreferencesId Display preferences id. (required) - * @param userId User Id. (required) * @param client Client. (required) * @param displayPreferencesDto New Display Preferences object. (required) + * @param userId User Id. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -374,8 +364,8 @@ public void updateDisplayPreferences(String displayPreferencesId, UUID userId, S 403 Forbidden - */ - public ApiResponse updateDisplayPreferencesWithHttpInfo(String displayPreferencesId, UUID userId, String client, DisplayPreferencesDto displayPreferencesDto) throws ApiException { - okhttp3.Call localVarCall = updateDisplayPreferencesValidateBeforeCall(displayPreferencesId, userId, client, displayPreferencesDto, null); + public ApiResponse updateDisplayPreferencesWithHttpInfo(String displayPreferencesId, String client, DisplayPreferencesDto displayPreferencesDto, UUID userId) throws ApiException { + okhttp3.Call localVarCall = updateDisplayPreferencesValidateBeforeCall(displayPreferencesId, client, displayPreferencesDto, userId, null); return localVarApiClient.execute(localVarCall); } @@ -383,9 +373,9 @@ public ApiResponse updateDisplayPreferencesWithHttpInfo(String displayPref * Update Display Preferences. (asynchronously) * * @param displayPreferencesId Display preferences id. (required) - * @param userId User Id. (required) * @param client Client. (required) * @param displayPreferencesDto New Display Preferences object. (required) + * @param userId User Id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -398,9 +388,9 @@ public ApiResponse updateDisplayPreferencesWithHttpInfo(String displayPref 403 Forbidden - */ - public okhttp3.Call updateDisplayPreferencesAsync(String displayPreferencesId, UUID userId, String client, DisplayPreferencesDto displayPreferencesDto, final ApiCallback _callback) throws ApiException { + public okhttp3.Call updateDisplayPreferencesAsync(String displayPreferencesId, String client, DisplayPreferencesDto displayPreferencesDto, UUID userId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = updateDisplayPreferencesValidateBeforeCall(displayPreferencesId, userId, client, displayPreferencesDto, _callback); + okhttp3.Call localVarCall = updateDisplayPreferencesValidateBeforeCall(displayPreferencesId, client, displayPreferencesDto, userId, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/DynamicHlsApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/DynamicHlsApi.java similarity index 94% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/DynamicHlsApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/DynamicHlsApi.java index 82d3165de4b5d..c9a2ed67d0e58 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/DynamicHlsApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/DynamicHlsApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -93,7 +93,7 @@ public void setCustomBaseUrl(String customBaseUrl) { * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -124,13 +124,14 @@ public void setCustomBaseUrl(String customBaseUrl) { * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -143,7 +144,7 @@ public void setCustomBaseUrl(String customBaseUrl) { 403 Forbidden - */ - public okhttp3.Call getHlsAudioSegmentCall(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getHlsAudioSegmentCall(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -372,6 +373,10 @@ public okhttp3.Call getHlsAudioSegmentCall(UUID itemId, String playlistId, Integ localVarQueryParams.addAll(localVarApiClient.parameterToPair("streamOptions", streamOptions)); } + if (enableAudioVbrEncoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAudioVbrEncoding", enableAudioVbrEncoding)); + } + final String[] localVarAccepts = { "audio/*" }; @@ -392,7 +397,7 @@ public okhttp3.Call getHlsAudioSegmentCall(UUID itemId, String playlistId, Integ } @SuppressWarnings("rawtypes") - private okhttp3.Call getHlsAudioSegmentValidateBeforeCall(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getHlsAudioSegmentValidateBeforeCall(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getHlsAudioSegment(Async)"); @@ -423,7 +428,7 @@ private okhttp3.Call getHlsAudioSegmentValidateBeforeCall(UUID itemId, String pl throw new ApiException("Missing the required parameter 'actualSegmentLengthTicks' when calling getHlsAudioSegment(Async)"); } - return getHlsAudioSegmentCall(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + return getHlsAudioSegmentCall(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, _callback); } @@ -446,7 +451,7 @@ private okhttp3.Call getHlsAudioSegmentValidateBeforeCall(UUID itemId, String pl * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -477,13 +482,14 @@ private okhttp3.Call getHlsAudioSegmentValidateBeforeCall(UUID itemId, String pl * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -495,8 +501,8 @@ private okhttp3.Call getHlsAudioSegmentValidateBeforeCall(UUID itemId, String pl 403 Forbidden - */ - public File getHlsAudioSegment(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - ApiResponse localVarResp = getHlsAudioSegmentWithHttpInfo(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions); + public File getHlsAudioSegment(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding) throws ApiException { + ApiResponse localVarResp = getHlsAudioSegmentWithHttpInfo(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); return localVarResp.getData(); } @@ -519,7 +525,7 @@ public File getHlsAudioSegment(UUID itemId, String playlistId, Integer segmentId * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -550,13 +556,14 @@ public File getHlsAudioSegment(UUID itemId, String playlistId, Integer segmentId * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -568,8 +575,8 @@ public File getHlsAudioSegment(UUID itemId, String playlistId, Integer segmentId 403 Forbidden - */ - public ApiResponse getHlsAudioSegmentWithHttpInfo(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - okhttp3.Call localVarCall = getHlsAudioSegmentValidateBeforeCall(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, null); + public ApiResponse getHlsAudioSegmentWithHttpInfo(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding) throws ApiException { + okhttp3.Call localVarCall = getHlsAudioSegmentValidateBeforeCall(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -593,7 +600,7 @@ public ApiResponse getHlsAudioSegmentWithHttpInfo(UUID itemId, String play * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -624,13 +631,14 @@ public ApiResponse getHlsAudioSegmentWithHttpInfo(UUID itemId, String play * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -643,9 +651,9 @@ public ApiResponse getHlsAudioSegmentWithHttpInfo(UUID itemId, String play 403 Forbidden - */ - public okhttp3.Call getHlsAudioSegmentAsync(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getHlsAudioSegmentAsync(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getHlsAudioSegmentValidateBeforeCall(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + okhttp3.Call localVarCall = getHlsAudioSegmentValidateBeforeCall(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -668,7 +676,7 @@ public okhttp3.Call getHlsAudioSegmentAsync(UUID itemId, String playlistId, Inte * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -700,13 +708,15 @@ public okhttp3.Call getHlsAudioSegmentAsync(UUID itemId, String playlistId, Inte * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -719,7 +729,7 @@ public okhttp3.Call getHlsAudioSegmentAsync(UUID itemId, String playlistId, Inte 403 Forbidden - */ - public okhttp3.Call getHlsVideoSegmentCall(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getHlsVideoSegmentCall(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -952,6 +962,14 @@ public okhttp3.Call getHlsVideoSegmentCall(UUID itemId, String playlistId, Integ localVarQueryParams.addAll(localVarApiClient.parameterToPair("streamOptions", streamOptions)); } + if (enableAudioVbrEncoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAudioVbrEncoding", enableAudioVbrEncoding)); + } + + if (alwaysBurnInSubtitleWhenTranscoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("alwaysBurnInSubtitleWhenTranscoding", alwaysBurnInSubtitleWhenTranscoding)); + } + final String[] localVarAccepts = { "video/*" }; @@ -972,7 +990,7 @@ public okhttp3.Call getHlsVideoSegmentCall(UUID itemId, String playlistId, Integ } @SuppressWarnings("rawtypes") - private okhttp3.Call getHlsVideoSegmentValidateBeforeCall(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getHlsVideoSegmentValidateBeforeCall(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getHlsVideoSegment(Async)"); @@ -1003,7 +1021,7 @@ private okhttp3.Call getHlsVideoSegmentValidateBeforeCall(UUID itemId, String pl throw new ApiException("Missing the required parameter 'actualSegmentLengthTicks' when calling getHlsVideoSegment(Async)"); } - return getHlsVideoSegmentCall(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + return getHlsVideoSegmentCall(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding, _callback); } @@ -1026,7 +1044,7 @@ private okhttp3.Call getHlsVideoSegmentValidateBeforeCall(UUID itemId, String pl * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1058,13 +1076,15 @@ private okhttp3.Call getHlsVideoSegmentValidateBeforeCall(UUID itemId, String pl * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1076,8 +1096,8 @@ private okhttp3.Call getHlsVideoSegmentValidateBeforeCall(UUID itemId, String pl 403 Forbidden - */ - public File getHlsVideoSegment(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - ApiResponse localVarResp = getHlsVideoSegmentWithHttpInfo(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions); + public File getHlsVideoSegment(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding) throws ApiException { + ApiResponse localVarResp = getHlsVideoSegmentWithHttpInfo(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding); return localVarResp.getData(); } @@ -1100,7 +1120,7 @@ public File getHlsVideoSegment(UUID itemId, String playlistId, Integer segmentId * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1132,13 +1152,15 @@ public File getHlsVideoSegment(UUID itemId, String playlistId, Integer segmentId * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1150,8 +1172,8 @@ public File getHlsVideoSegment(UUID itemId, String playlistId, Integer segmentId 403 Forbidden - */ - public ApiResponse getHlsVideoSegmentWithHttpInfo(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - okhttp3.Call localVarCall = getHlsVideoSegmentValidateBeforeCall(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, null); + public ApiResponse getHlsVideoSegmentWithHttpInfo(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding) throws ApiException { + okhttp3.Call localVarCall = getHlsVideoSegmentValidateBeforeCall(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -1175,7 +1197,7 @@ public ApiResponse getHlsVideoSegmentWithHttpInfo(UUID itemId, String play * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1207,13 +1229,15 @@ public ApiResponse getHlsVideoSegmentWithHttpInfo(UUID itemId, String play * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -1226,9 +1250,9 @@ public ApiResponse getHlsVideoSegmentWithHttpInfo(UUID itemId, String play 403 Forbidden - */ - public okhttp3.Call getHlsVideoSegmentAsync(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getHlsVideoSegmentAsync(UUID itemId, String playlistId, Integer segmentId, String container, Long runtimeTicks, Long actualSegmentLengthTicks, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getHlsVideoSegmentValidateBeforeCall(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + okhttp3.Call localVarCall = getHlsVideoSegmentValidateBeforeCall(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -1243,11 +1267,11 @@ public okhttp3.Call getHlsVideoSegmentAsync(UUID itemId, String playlistId, Inte * @param deviceProfileId Optional. The dlna device profile id to utilize. (optional) * @param playSessionId The play session id. (optional) * @param segmentContainer The segment container. (optional) - * @param segmentLength The segment lenght. (optional) + * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1277,7 +1301,7 @@ public okhttp3.Call getHlsVideoSegmentAsync(UUID itemId, String playlistId, Inte * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -1287,6 +1311,8 @@ public okhttp3.Call getHlsVideoSegmentAsync(UUID itemId, String playlistId, Inte * @param maxWidth Optional. The max width. (optional) * @param maxHeight Optional. The max height. (optional) * @param enableSubtitlesInManifest Optional. Whether to enable subtitles in the manifest. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -1299,7 +1325,7 @@ public okhttp3.Call getHlsVideoSegmentAsync(UUID itemId, String playlistId, Inte 403 Forbidden - */ - public okhttp3.Call getLiveHlsStreamCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Integer maxWidth, Integer maxHeight, Boolean enableSubtitlesInManifest, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getLiveHlsStreamCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Integer maxWidth, Integer maxHeight, Boolean enableSubtitlesInManifest, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1529,6 +1555,14 @@ public okhttp3.Call getLiveHlsStreamCall(UUID itemId, String container, Boolean localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableSubtitlesInManifest", enableSubtitlesInManifest)); } + if (enableAudioVbrEncoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAudioVbrEncoding", enableAudioVbrEncoding)); + } + + if (alwaysBurnInSubtitleWhenTranscoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("alwaysBurnInSubtitleWhenTranscoding", alwaysBurnInSubtitleWhenTranscoding)); + } + final String[] localVarAccepts = { "application/x-mpegURL" }; @@ -1549,13 +1583,13 @@ public okhttp3.Call getLiveHlsStreamCall(UUID itemId, String container, Boolean } @SuppressWarnings("rawtypes") - private okhttp3.Call getLiveHlsStreamValidateBeforeCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Integer maxWidth, Integer maxHeight, Boolean enableSubtitlesInManifest, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getLiveHlsStreamValidateBeforeCall(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Integer maxWidth, Integer maxHeight, Boolean enableSubtitlesInManifest, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getLiveHlsStream(Async)"); } - return getLiveHlsStreamCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, maxWidth, maxHeight, enableSubtitlesInManifest, _callback); + return getLiveHlsStreamCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, maxWidth, maxHeight, enableSubtitlesInManifest, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding, _callback); } @@ -1570,11 +1604,11 @@ private okhttp3.Call getLiveHlsStreamValidateBeforeCall(UUID itemId, String cont * @param deviceProfileId Optional. The dlna device profile id to utilize. (optional) * @param playSessionId The play session id. (optional) * @param segmentContainer The segment container. (optional) - * @param segmentLength The segment lenght. (optional) + * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1604,7 +1638,7 @@ private okhttp3.Call getLiveHlsStreamValidateBeforeCall(UUID itemId, String cont * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -1614,6 +1648,8 @@ private okhttp3.Call getLiveHlsStreamValidateBeforeCall(UUID itemId, String cont * @param maxWidth Optional. The max width. (optional) * @param maxHeight Optional. The max height. (optional) * @param enableSubtitlesInManifest Optional. Whether to enable subtitles in the manifest. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1625,8 +1661,8 @@ private okhttp3.Call getLiveHlsStreamValidateBeforeCall(UUID itemId, String cont 403 Forbidden - */ - public File getLiveHlsStream(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Integer maxWidth, Integer maxHeight, Boolean enableSubtitlesInManifest) throws ApiException { - ApiResponse localVarResp = getLiveHlsStreamWithHttpInfo(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, maxWidth, maxHeight, enableSubtitlesInManifest); + public File getLiveHlsStream(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Integer maxWidth, Integer maxHeight, Boolean enableSubtitlesInManifest, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding) throws ApiException { + ApiResponse localVarResp = getLiveHlsStreamWithHttpInfo(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, maxWidth, maxHeight, enableSubtitlesInManifest, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding); return localVarResp.getData(); } @@ -1641,11 +1677,11 @@ public File getLiveHlsStream(UUID itemId, String container, Boolean _static, Str * @param deviceProfileId Optional. The dlna device profile id to utilize. (optional) * @param playSessionId The play session id. (optional) * @param segmentContainer The segment container. (optional) - * @param segmentLength The segment lenght. (optional) + * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1675,7 +1711,7 @@ public File getLiveHlsStream(UUID itemId, String container, Boolean _static, Str * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -1685,6 +1721,8 @@ public File getLiveHlsStream(UUID itemId, String container, Boolean _static, Str * @param maxWidth Optional. The max width. (optional) * @param maxHeight Optional. The max height. (optional) * @param enableSubtitlesInManifest Optional. Whether to enable subtitles in the manifest. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1696,8 +1734,8 @@ public File getLiveHlsStream(UUID itemId, String container, Boolean _static, Str 403 Forbidden - */ - public ApiResponse getLiveHlsStreamWithHttpInfo(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Integer maxWidth, Integer maxHeight, Boolean enableSubtitlesInManifest) throws ApiException { - okhttp3.Call localVarCall = getLiveHlsStreamValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, maxWidth, maxHeight, enableSubtitlesInManifest, null); + public ApiResponse getLiveHlsStreamWithHttpInfo(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Integer maxWidth, Integer maxHeight, Boolean enableSubtitlesInManifest, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding) throws ApiException { + okhttp3.Call localVarCall = getLiveHlsStreamValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, maxWidth, maxHeight, enableSubtitlesInManifest, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -1713,11 +1751,11 @@ public ApiResponse getLiveHlsStreamWithHttpInfo(UUID itemId, String contai * @param deviceProfileId Optional. The dlna device profile id to utilize. (optional) * @param playSessionId The play session id. (optional) * @param segmentContainer The segment container. (optional) - * @param segmentLength The segment lenght. (optional) + * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1747,7 +1785,7 @@ public ApiResponse getLiveHlsStreamWithHttpInfo(UUID itemId, String contai * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -1757,6 +1795,8 @@ public ApiResponse getLiveHlsStreamWithHttpInfo(UUID itemId, String contai * @param maxWidth Optional. The max width. (optional) * @param maxHeight Optional. The max height. (optional) * @param enableSubtitlesInManifest Optional. Whether to enable subtitles in the manifest. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -1769,9 +1809,9 @@ public ApiResponse getLiveHlsStreamWithHttpInfo(UUID itemId, String contai 403 Forbidden - */ - public okhttp3.Call getLiveHlsStreamAsync(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Integer maxWidth, Integer maxHeight, Boolean enableSubtitlesInManifest, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getLiveHlsStreamAsync(UUID itemId, String container, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Integer maxWidth, Integer maxHeight, Boolean enableSubtitlesInManifest, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getLiveHlsStreamValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, maxWidth, maxHeight, enableSubtitlesInManifest, _callback); + okhttp3.Call localVarCall = getLiveHlsStreamValidateBeforeCall(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, maxWidth, maxHeight, enableSubtitlesInManifest, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -1789,7 +1829,7 @@ public okhttp3.Call getLiveHlsStreamAsync(UUID itemId, String container, Boolean * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -1820,7 +1860,7 @@ public okhttp3.Call getLiveHlsStreamAsync(UUID itemId, String container, Boolean * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -1828,6 +1868,7 @@ public okhttp3.Call getLiveHlsStreamAsync(UUID itemId, String container, Boolean * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -1840,7 +1881,7 @@ public okhttp3.Call getLiveHlsStreamAsync(UUID itemId, String container, Boolean 403 Forbidden - */ - public okhttp3.Call getMasterHlsAudioPlaylistCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getMasterHlsAudioPlaylistCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -2062,6 +2103,10 @@ public okhttp3.Call getMasterHlsAudioPlaylistCall(UUID itemId, String mediaSourc localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAdaptiveBitrateStreaming", enableAdaptiveBitrateStreaming)); } + if (enableAudioVbrEncoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAudioVbrEncoding", enableAudioVbrEncoding)); + } + final String[] localVarAccepts = { "application/x-mpegURL" }; @@ -2082,7 +2127,7 @@ public okhttp3.Call getMasterHlsAudioPlaylistCall(UUID itemId, String mediaSourc } @SuppressWarnings("rawtypes") - private okhttp3.Call getMasterHlsAudioPlaylistValidateBeforeCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getMasterHlsAudioPlaylistValidateBeforeCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getMasterHlsAudioPlaylist(Async)"); @@ -2093,7 +2138,7 @@ private okhttp3.Call getMasterHlsAudioPlaylistValidateBeforeCall(UUID itemId, St throw new ApiException("Missing the required parameter 'mediaSourceId' when calling getMasterHlsAudioPlaylist(Async)"); } - return getMasterHlsAudioPlaylistCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, _callback); + return getMasterHlsAudioPlaylistCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding, _callback); } @@ -2111,7 +2156,7 @@ private okhttp3.Call getMasterHlsAudioPlaylistValidateBeforeCall(UUID itemId, St * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -2142,7 +2187,7 @@ private okhttp3.Call getMasterHlsAudioPlaylistValidateBeforeCall(UUID itemId, St * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -2150,6 +2195,7 @@ private okhttp3.Call getMasterHlsAudioPlaylistValidateBeforeCall(UUID itemId, St * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2161,8 +2207,8 @@ private okhttp3.Call getMasterHlsAudioPlaylistValidateBeforeCall(UUID itemId, St 403 Forbidden - */ - public File getMasterHlsAudioPlaylist(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming) throws ApiException { - ApiResponse localVarResp = getMasterHlsAudioPlaylistWithHttpInfo(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming); + public File getMasterHlsAudioPlaylist(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableAudioVbrEncoding) throws ApiException { + ApiResponse localVarResp = getMasterHlsAudioPlaylistWithHttpInfo(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding); return localVarResp.getData(); } @@ -2180,7 +2226,7 @@ public File getMasterHlsAudioPlaylist(UUID itemId, String mediaSourceId, Boolean * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -2211,7 +2257,7 @@ public File getMasterHlsAudioPlaylist(UUID itemId, String mediaSourceId, Boolean * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -2219,6 +2265,7 @@ public File getMasterHlsAudioPlaylist(UUID itemId, String mediaSourceId, Boolean * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2230,8 +2277,8 @@ public File getMasterHlsAudioPlaylist(UUID itemId, String mediaSourceId, Boolean 403 Forbidden - */ - public ApiResponse getMasterHlsAudioPlaylistWithHttpInfo(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming) throws ApiException { - okhttp3.Call localVarCall = getMasterHlsAudioPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, null); + public ApiResponse getMasterHlsAudioPlaylistWithHttpInfo(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableAudioVbrEncoding) throws ApiException { + okhttp3.Call localVarCall = getMasterHlsAudioPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -2250,7 +2297,7 @@ public ApiResponse getMasterHlsAudioPlaylistWithHttpInfo(UUID itemId, Stri * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -2281,7 +2328,7 @@ public ApiResponse getMasterHlsAudioPlaylistWithHttpInfo(UUID itemId, Stri * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -2289,6 +2336,7 @@ public ApiResponse getMasterHlsAudioPlaylistWithHttpInfo(UUID itemId, Stri * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -2301,9 +2349,9 @@ public ApiResponse getMasterHlsAudioPlaylistWithHttpInfo(UUID itemId, Stri 403 Forbidden - */ - public okhttp3.Call getMasterHlsAudioPlaylistAsync(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getMasterHlsAudioPlaylistAsync(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getMasterHlsAudioPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, _callback); + okhttp3.Call localVarCall = getMasterHlsAudioPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -2321,7 +2369,7 @@ public okhttp3.Call getMasterHlsAudioPlaylistAsync(UUID itemId, String mediaSour * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -2353,7 +2401,7 @@ public okhttp3.Call getMasterHlsAudioPlaylistAsync(UUID itemId, String mediaSour * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -2361,6 +2409,9 @@ public okhttp3.Call getMasterHlsAudioPlaylistAsync(UUID itemId, String mediaSour * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableTrickplay Enable trickplay image playlists being added to master playlist. (optional, default to true) + * @param enableAudioVbrEncoding Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -2373,7 +2424,7 @@ public okhttp3.Call getMasterHlsAudioPlaylistAsync(UUID itemId, String mediaSour 403 Forbidden - */ - public okhttp3.Call getMasterHlsVideoPlaylistCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getMasterHlsVideoPlaylistCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableTrickplay, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -2599,6 +2650,18 @@ public okhttp3.Call getMasterHlsVideoPlaylistCall(UUID itemId, String mediaSourc localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAdaptiveBitrateStreaming", enableAdaptiveBitrateStreaming)); } + if (enableTrickplay != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableTrickplay", enableTrickplay)); + } + + if (enableAudioVbrEncoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAudioVbrEncoding", enableAudioVbrEncoding)); + } + + if (alwaysBurnInSubtitleWhenTranscoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("alwaysBurnInSubtitleWhenTranscoding", alwaysBurnInSubtitleWhenTranscoding)); + } + final String[] localVarAccepts = { "application/x-mpegURL" }; @@ -2619,7 +2682,7 @@ public okhttp3.Call getMasterHlsVideoPlaylistCall(UUID itemId, String mediaSourc } @SuppressWarnings("rawtypes") - private okhttp3.Call getMasterHlsVideoPlaylistValidateBeforeCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getMasterHlsVideoPlaylistValidateBeforeCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableTrickplay, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getMasterHlsVideoPlaylist(Async)"); @@ -2630,7 +2693,7 @@ private okhttp3.Call getMasterHlsVideoPlaylistValidateBeforeCall(UUID itemId, St throw new ApiException("Missing the required parameter 'mediaSourceId' when calling getMasterHlsVideoPlaylist(Async)"); } - return getMasterHlsVideoPlaylistCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, _callback); + return getMasterHlsVideoPlaylistCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding, _callback); } @@ -2648,7 +2711,7 @@ private okhttp3.Call getMasterHlsVideoPlaylistValidateBeforeCall(UUID itemId, St * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -2680,7 +2743,7 @@ private okhttp3.Call getMasterHlsVideoPlaylistValidateBeforeCall(UUID itemId, St * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -2688,6 +2751,9 @@ private okhttp3.Call getMasterHlsVideoPlaylistValidateBeforeCall(UUID itemId, St * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableTrickplay Enable trickplay image playlists being added to master playlist. (optional, default to true) + * @param enableAudioVbrEncoding Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2699,8 +2765,8 @@ private okhttp3.Call getMasterHlsVideoPlaylistValidateBeforeCall(UUID itemId, St 403 Forbidden - */ - public File getMasterHlsVideoPlaylist(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming) throws ApiException { - ApiResponse localVarResp = getMasterHlsVideoPlaylistWithHttpInfo(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming); + public File getMasterHlsVideoPlaylist(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableTrickplay, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding) throws ApiException { + ApiResponse localVarResp = getMasterHlsVideoPlaylistWithHttpInfo(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding); return localVarResp.getData(); } @@ -2718,7 +2784,7 @@ public File getMasterHlsVideoPlaylist(UUID itemId, String mediaSourceId, Boolean * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -2750,7 +2816,7 @@ public File getMasterHlsVideoPlaylist(UUID itemId, String mediaSourceId, Boolean * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -2758,6 +2824,9 @@ public File getMasterHlsVideoPlaylist(UUID itemId, String mediaSourceId, Boolean * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableTrickplay Enable trickplay image playlists being added to master playlist. (optional, default to true) + * @param enableAudioVbrEncoding Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2769,8 +2838,8 @@ public File getMasterHlsVideoPlaylist(UUID itemId, String mediaSourceId, Boolean 403 Forbidden - */ - public ApiResponse getMasterHlsVideoPlaylistWithHttpInfo(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming) throws ApiException { - okhttp3.Call localVarCall = getMasterHlsVideoPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, null); + public ApiResponse getMasterHlsVideoPlaylistWithHttpInfo(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableTrickplay, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding) throws ApiException { + okhttp3.Call localVarCall = getMasterHlsVideoPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -2789,7 +2858,7 @@ public ApiResponse getMasterHlsVideoPlaylistWithHttpInfo(UUID itemId, Stri * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -2821,7 +2890,7 @@ public ApiResponse getMasterHlsVideoPlaylistWithHttpInfo(UUID itemId, Stri * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -2829,6 +2898,9 @@ public ApiResponse getMasterHlsVideoPlaylistWithHttpInfo(UUID itemId, Stri * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableTrickplay Enable trickplay image playlists being added to master playlist. (optional, default to true) + * @param enableAudioVbrEncoding Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -2841,9 +2913,9 @@ public ApiResponse getMasterHlsVideoPlaylistWithHttpInfo(UUID itemId, Stri 403 Forbidden - */ - public okhttp3.Call getMasterHlsVideoPlaylistAsync(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getMasterHlsVideoPlaylistAsync(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableTrickplay, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getMasterHlsVideoPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, _callback); + okhttp3.Call localVarCall = getMasterHlsVideoPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -2861,7 +2933,7 @@ public okhttp3.Call getMasterHlsVideoPlaylistAsync(UUID itemId, String mediaSour * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -2892,13 +2964,14 @@ public okhttp3.Call getMasterHlsVideoPlaylistAsync(UUID itemId, String mediaSour * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -2911,7 +2984,7 @@ public okhttp3.Call getMasterHlsVideoPlaylistAsync(UUID itemId, String mediaSour 403 Forbidden - */ - public okhttp3.Call getVariantHlsAudioPlaylistCall(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getVariantHlsAudioPlaylistCall(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -3129,6 +3202,10 @@ public okhttp3.Call getVariantHlsAudioPlaylistCall(UUID itemId, Boolean _static, localVarQueryParams.addAll(localVarApiClient.parameterToPair("streamOptions", streamOptions)); } + if (enableAudioVbrEncoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAudioVbrEncoding", enableAudioVbrEncoding)); + } + final String[] localVarAccepts = { "application/x-mpegURL" }; @@ -3149,13 +3226,13 @@ public okhttp3.Call getVariantHlsAudioPlaylistCall(UUID itemId, Boolean _static, } @SuppressWarnings("rawtypes") - private okhttp3.Call getVariantHlsAudioPlaylistValidateBeforeCall(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getVariantHlsAudioPlaylistValidateBeforeCall(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getVariantHlsAudioPlaylist(Async)"); } - return getVariantHlsAudioPlaylistCall(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + return getVariantHlsAudioPlaylistCall(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, _callback); } @@ -3173,7 +3250,7 @@ private okhttp3.Call getVariantHlsAudioPlaylistValidateBeforeCall(UUID itemId, B * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -3204,13 +3281,14 @@ private okhttp3.Call getVariantHlsAudioPlaylistValidateBeforeCall(UUID itemId, B * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3222,8 +3300,8 @@ private okhttp3.Call getVariantHlsAudioPlaylistValidateBeforeCall(UUID itemId, B 403 Forbidden - */ - public File getVariantHlsAudioPlaylist(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - ApiResponse localVarResp = getVariantHlsAudioPlaylistWithHttpInfo(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions); + public File getVariantHlsAudioPlaylist(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding) throws ApiException { + ApiResponse localVarResp = getVariantHlsAudioPlaylistWithHttpInfo(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding); return localVarResp.getData(); } @@ -3241,7 +3319,7 @@ public File getVariantHlsAudioPlaylist(UUID itemId, Boolean _static, String para * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -3272,13 +3350,14 @@ public File getVariantHlsAudioPlaylist(UUID itemId, Boolean _static, String para * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3290,8 +3369,8 @@ public File getVariantHlsAudioPlaylist(UUID itemId, Boolean _static, String para 403 Forbidden - */ - public ApiResponse getVariantHlsAudioPlaylistWithHttpInfo(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - okhttp3.Call localVarCall = getVariantHlsAudioPlaylistValidateBeforeCall(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, null); + public ApiResponse getVariantHlsAudioPlaylistWithHttpInfo(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding) throws ApiException { + okhttp3.Call localVarCall = getVariantHlsAudioPlaylistValidateBeforeCall(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -3310,7 +3389,7 @@ public ApiResponse getVariantHlsAudioPlaylistWithHttpInfo(UUID itemId, Boo * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -3341,13 +3420,14 @@ public ApiResponse getVariantHlsAudioPlaylistWithHttpInfo(UUID itemId, Boo * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -3360,9 +3440,9 @@ public ApiResponse getVariantHlsAudioPlaylistWithHttpInfo(UUID itemId, Boo 403 Forbidden - */ - public okhttp3.Call getVariantHlsAudioPlaylistAsync(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getVariantHlsAudioPlaylistAsync(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getVariantHlsAudioPlaylistValidateBeforeCall(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + okhttp3.Call localVarCall = getVariantHlsAudioPlaylistValidateBeforeCall(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -3380,7 +3460,7 @@ public okhttp3.Call getVariantHlsAudioPlaylistAsync(UUID itemId, Boolean _static * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -3412,13 +3492,15 @@ public okhttp3.Call getVariantHlsAudioPlaylistAsync(UUID itemId, Boolean _static * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -3431,7 +3513,7 @@ public okhttp3.Call getVariantHlsAudioPlaylistAsync(UUID itemId, Boolean _static 403 Forbidden - */ - public okhttp3.Call getVariantHlsVideoPlaylistCall(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getVariantHlsVideoPlaylistCall(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -3653,6 +3735,14 @@ public okhttp3.Call getVariantHlsVideoPlaylistCall(UUID itemId, Boolean _static, localVarQueryParams.addAll(localVarApiClient.parameterToPair("streamOptions", streamOptions)); } + if (enableAudioVbrEncoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAudioVbrEncoding", enableAudioVbrEncoding)); + } + + if (alwaysBurnInSubtitleWhenTranscoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("alwaysBurnInSubtitleWhenTranscoding", alwaysBurnInSubtitleWhenTranscoding)); + } + final String[] localVarAccepts = { "application/x-mpegURL" }; @@ -3673,13 +3763,13 @@ public okhttp3.Call getVariantHlsVideoPlaylistCall(UUID itemId, Boolean _static, } @SuppressWarnings("rawtypes") - private okhttp3.Call getVariantHlsVideoPlaylistValidateBeforeCall(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getVariantHlsVideoPlaylistValidateBeforeCall(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getVariantHlsVideoPlaylist(Async)"); } - return getVariantHlsVideoPlaylistCall(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + return getVariantHlsVideoPlaylistCall(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding, _callback); } @@ -3697,7 +3787,7 @@ private okhttp3.Call getVariantHlsVideoPlaylistValidateBeforeCall(UUID itemId, B * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -3729,13 +3819,15 @@ private okhttp3.Call getVariantHlsVideoPlaylistValidateBeforeCall(UUID itemId, B * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3747,8 +3839,8 @@ private okhttp3.Call getVariantHlsVideoPlaylistValidateBeforeCall(UUID itemId, B 403 Forbidden - */ - public File getVariantHlsVideoPlaylist(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - ApiResponse localVarResp = getVariantHlsVideoPlaylistWithHttpInfo(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions); + public File getVariantHlsVideoPlaylist(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding) throws ApiException { + ApiResponse localVarResp = getVariantHlsVideoPlaylistWithHttpInfo(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding); return localVarResp.getData(); } @@ -3766,7 +3858,7 @@ public File getVariantHlsVideoPlaylist(UUID itemId, Boolean _static, String para * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -3798,13 +3890,15 @@ public File getVariantHlsVideoPlaylist(UUID itemId, Boolean _static, String para * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3816,8 +3910,8 @@ public File getVariantHlsVideoPlaylist(UUID itemId, Boolean _static, String para 403 Forbidden - */ - public ApiResponse getVariantHlsVideoPlaylistWithHttpInfo(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions) throws ApiException { - okhttp3.Call localVarCall = getVariantHlsVideoPlaylistValidateBeforeCall(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, null); + public ApiResponse getVariantHlsVideoPlaylistWithHttpInfo(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding) throws ApiException { + okhttp3.Call localVarCall = getVariantHlsVideoPlaylistValidateBeforeCall(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -3836,7 +3930,7 @@ public ApiResponse getVariantHlsVideoPlaylistWithHttpInfo(UUID itemId, Boo * @param minSegments The minimum number of segments. (optional) * @param mediaSourceId The media version id, if playing an alternate version. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -3868,13 +3962,15 @@ public ApiResponse getVariantHlsVideoPlaylistWithHttpInfo(UUID itemId, Boo * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) * @param videoStreamIndex Optional. The index of the video stream to use. If omitted the first video stream will be used. (optional) * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -3887,9 +3983,9 @@ public ApiResponse getVariantHlsVideoPlaylistWithHttpInfo(UUID itemId, Boo 403 Forbidden - */ - public okhttp3.Call getVariantHlsVideoPlaylistAsync(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getVariantHlsVideoPlaylistAsync(UUID itemId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String mediaSourceId, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getVariantHlsVideoPlaylistValidateBeforeCall(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, _callback); + okhttp3.Call localVarCall = getVariantHlsVideoPlaylistValidateBeforeCall(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -3907,7 +4003,7 @@ public okhttp3.Call getVariantHlsVideoPlaylistAsync(UUID itemId, Boolean _static * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -3938,7 +4034,7 @@ public okhttp3.Call getVariantHlsVideoPlaylistAsync(UUID itemId, Boolean _static * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -3946,6 +4042,7 @@ public okhttp3.Call getVariantHlsVideoPlaylistAsync(UUID itemId, Boolean _static * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -3958,7 +4055,7 @@ public okhttp3.Call getVariantHlsVideoPlaylistAsync(UUID itemId, Boolean _static 403 Forbidden - */ - public okhttp3.Call headMasterHlsAudioPlaylistCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headMasterHlsAudioPlaylistCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -4180,6 +4277,10 @@ public okhttp3.Call headMasterHlsAudioPlaylistCall(UUID itemId, String mediaSour localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAdaptiveBitrateStreaming", enableAdaptiveBitrateStreaming)); } + if (enableAudioVbrEncoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAudioVbrEncoding", enableAudioVbrEncoding)); + } + final String[] localVarAccepts = { "application/x-mpegURL" }; @@ -4200,7 +4301,7 @@ public okhttp3.Call headMasterHlsAudioPlaylistCall(UUID itemId, String mediaSour } @SuppressWarnings("rawtypes") - private okhttp3.Call headMasterHlsAudioPlaylistValidateBeforeCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, final ApiCallback _callback) throws ApiException { + private okhttp3.Call headMasterHlsAudioPlaylistValidateBeforeCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling headMasterHlsAudioPlaylist(Async)"); @@ -4211,7 +4312,7 @@ private okhttp3.Call headMasterHlsAudioPlaylistValidateBeforeCall(UUID itemId, S throw new ApiException("Missing the required parameter 'mediaSourceId' when calling headMasterHlsAudioPlaylist(Async)"); } - return headMasterHlsAudioPlaylistCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, _callback); + return headMasterHlsAudioPlaylistCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding, _callback); } @@ -4229,7 +4330,7 @@ private okhttp3.Call headMasterHlsAudioPlaylistValidateBeforeCall(UUID itemId, S * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -4260,7 +4361,7 @@ private okhttp3.Call headMasterHlsAudioPlaylistValidateBeforeCall(UUID itemId, S * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -4268,6 +4369,7 @@ private okhttp3.Call headMasterHlsAudioPlaylistValidateBeforeCall(UUID itemId, S * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -4279,8 +4381,8 @@ private okhttp3.Call headMasterHlsAudioPlaylistValidateBeforeCall(UUID itemId, S 403 Forbidden - */ - public File headMasterHlsAudioPlaylist(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming) throws ApiException { - ApiResponse localVarResp = headMasterHlsAudioPlaylistWithHttpInfo(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming); + public File headMasterHlsAudioPlaylist(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableAudioVbrEncoding) throws ApiException { + ApiResponse localVarResp = headMasterHlsAudioPlaylistWithHttpInfo(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding); return localVarResp.getData(); } @@ -4298,7 +4400,7 @@ public File headMasterHlsAudioPlaylist(UUID itemId, String mediaSourceId, Boolea * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -4329,7 +4431,7 @@ public File headMasterHlsAudioPlaylist(UUID itemId, String mediaSourceId, Boolea * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -4337,6 +4439,7 @@ public File headMasterHlsAudioPlaylist(UUID itemId, String mediaSourceId, Boolea * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -4348,8 +4451,8 @@ public File headMasterHlsAudioPlaylist(UUID itemId, String mediaSourceId, Boolea 403 Forbidden - */ - public ApiResponse headMasterHlsAudioPlaylistWithHttpInfo(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming) throws ApiException { - okhttp3.Call localVarCall = headMasterHlsAudioPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, null); + public ApiResponse headMasterHlsAudioPlaylistWithHttpInfo(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableAudioVbrEncoding) throws ApiException { + okhttp3.Call localVarCall = headMasterHlsAudioPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -4368,7 +4471,7 @@ public ApiResponse headMasterHlsAudioPlaylistWithHttpInfo(UUID itemId, Str * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -4399,7 +4502,7 @@ public ApiResponse headMasterHlsAudioPlaylistWithHttpInfo(UUID itemId, Str * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -4407,6 +4510,7 @@ public ApiResponse headMasterHlsAudioPlaylistWithHttpInfo(UUID itemId, Str * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -4419,9 +4523,9 @@ public ApiResponse headMasterHlsAudioPlaylistWithHttpInfo(UUID itemId, Str 403 Forbidden - */ - public okhttp3.Call headMasterHlsAudioPlaylistAsync(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headMasterHlsAudioPlaylistAsync(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer maxStreamingBitrate, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableAudioVbrEncoding, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headMasterHlsAudioPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, _callback); + okhttp3.Call localVarCall = headMasterHlsAudioPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -4439,7 +4543,7 @@ public okhttp3.Call headMasterHlsAudioPlaylistAsync(UUID itemId, String mediaSou * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -4471,7 +4575,7 @@ public okhttp3.Call headMasterHlsAudioPlaylistAsync(UUID itemId, String mediaSou * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -4479,6 +4583,9 @@ public okhttp3.Call headMasterHlsAudioPlaylistAsync(UUID itemId, String mediaSou * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableTrickplay Enable trickplay image playlists being added to master playlist. (optional, default to true) + * @param enableAudioVbrEncoding Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -4491,7 +4598,7 @@ public okhttp3.Call headMasterHlsAudioPlaylistAsync(UUID itemId, String mediaSou 403 Forbidden - */ - public okhttp3.Call headMasterHlsVideoPlaylistCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headMasterHlsVideoPlaylistCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableTrickplay, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -4717,6 +4824,18 @@ public okhttp3.Call headMasterHlsVideoPlaylistCall(UUID itemId, String mediaSour localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAdaptiveBitrateStreaming", enableAdaptiveBitrateStreaming)); } + if (enableTrickplay != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableTrickplay", enableTrickplay)); + } + + if (enableAudioVbrEncoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAudioVbrEncoding", enableAudioVbrEncoding)); + } + + if (alwaysBurnInSubtitleWhenTranscoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("alwaysBurnInSubtitleWhenTranscoding", alwaysBurnInSubtitleWhenTranscoding)); + } + final String[] localVarAccepts = { "application/x-mpegURL" }; @@ -4737,7 +4856,7 @@ public okhttp3.Call headMasterHlsVideoPlaylistCall(UUID itemId, String mediaSour } @SuppressWarnings("rawtypes") - private okhttp3.Call headMasterHlsVideoPlaylistValidateBeforeCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, final ApiCallback _callback) throws ApiException { + private okhttp3.Call headMasterHlsVideoPlaylistValidateBeforeCall(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableTrickplay, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling headMasterHlsVideoPlaylist(Async)"); @@ -4748,7 +4867,7 @@ private okhttp3.Call headMasterHlsVideoPlaylistValidateBeforeCall(UUID itemId, S throw new ApiException("Missing the required parameter 'mediaSourceId' when calling headMasterHlsVideoPlaylist(Async)"); } - return headMasterHlsVideoPlaylistCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, _callback); + return headMasterHlsVideoPlaylistCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding, _callback); } @@ -4766,7 +4885,7 @@ private okhttp3.Call headMasterHlsVideoPlaylistValidateBeforeCall(UUID itemId, S * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -4798,7 +4917,7 @@ private okhttp3.Call headMasterHlsVideoPlaylistValidateBeforeCall(UUID itemId, S * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -4806,6 +4925,9 @@ private okhttp3.Call headMasterHlsVideoPlaylistValidateBeforeCall(UUID itemId, S * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableTrickplay Enable trickplay image playlists being added to master playlist. (optional, default to true) + * @param enableAudioVbrEncoding Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -4817,8 +4939,8 @@ private okhttp3.Call headMasterHlsVideoPlaylistValidateBeforeCall(UUID itemId, S 403 Forbidden - */ - public File headMasterHlsVideoPlaylist(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming) throws ApiException { - ApiResponse localVarResp = headMasterHlsVideoPlaylistWithHttpInfo(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming); + public File headMasterHlsVideoPlaylist(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableTrickplay, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding) throws ApiException { + ApiResponse localVarResp = headMasterHlsVideoPlaylistWithHttpInfo(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding); return localVarResp.getData(); } @@ -4836,7 +4958,7 @@ public File headMasterHlsVideoPlaylist(UUID itemId, String mediaSourceId, Boolea * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -4868,7 +4990,7 @@ public File headMasterHlsVideoPlaylist(UUID itemId, String mediaSourceId, Boolea * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -4876,6 +4998,9 @@ public File headMasterHlsVideoPlaylist(UUID itemId, String mediaSourceId, Boolea * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableTrickplay Enable trickplay image playlists being added to master playlist. (optional, default to true) + * @param enableAudioVbrEncoding Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -4887,8 +5012,8 @@ public File headMasterHlsVideoPlaylist(UUID itemId, String mediaSourceId, Boolea 403 Forbidden - */ - public ApiResponse headMasterHlsVideoPlaylistWithHttpInfo(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming) throws ApiException { - okhttp3.Call localVarCall = headMasterHlsVideoPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, null); + public ApiResponse headMasterHlsVideoPlaylistWithHttpInfo(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableTrickplay, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding) throws ApiException { + okhttp3.Call localVarCall = headMasterHlsVideoPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -4907,7 +5032,7 @@ public ApiResponse headMasterHlsVideoPlaylistWithHttpInfo(UUID itemId, Str * @param segmentLength The segment length. (optional) * @param minSegments The minimum number of segments. (optional) * @param deviceId The device id of the client requesting. Used to stop encoding processes when needed. (optional) - * @param audioCodec Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. (optional) + * @param audioCodec Optional. Specify an audio codec to encode to, e.g. mp3. (optional) * @param enableAutoStreamCopy Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. (optional) * @param allowVideoStreamCopy Whether or not to allow copying of the video stream url. (optional) * @param allowAudioStreamCopy Whether or not to allow copying of the audio stream url. (optional) @@ -4939,7 +5064,7 @@ public ApiResponse headMasterHlsVideoPlaylistWithHttpInfo(UUID itemId, Str * @param cpuCoreLimit Optional. The limit of how many cpu cores to use. (optional) * @param liveStreamId The live stream id. (optional) * @param enableMpegtsM2TsMode Optional. Whether to enable the MpegtsM2Ts mode. (optional) - * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. (optional) + * @param videoCodec Optional. Specify a video codec to encode to, e.g. h264. (optional) * @param subtitleCodec Optional. Specify a subtitle codec to encode to. (optional) * @param transcodeReasons Optional. The transcoding reason. (optional) * @param audioStreamIndex Optional. The index of the audio stream to use. If omitted the first audio stream will be used. (optional) @@ -4947,6 +5072,9 @@ public ApiResponse headMasterHlsVideoPlaylistWithHttpInfo(UUID itemId, Str * @param context Optional. The MediaBrowser.Model.Dlna.EncodingContext. (optional) * @param streamOptions Optional. The streaming options. (optional) * @param enableAdaptiveBitrateStreaming Enable adaptive bitrate streaming. (optional, default to true) + * @param enableTrickplay Enable trickplay image playlists being added to master playlist. (optional, default to true) + * @param enableAudioVbrEncoding Whether to enable Audio Encoding. (optional, default to true) + * @param alwaysBurnInSubtitleWhenTranscoding Whether to always burn in subtitles when transcoding. (optional, default to false) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -4959,9 +5087,9 @@ public ApiResponse headMasterHlsVideoPlaylistWithHttpInfo(UUID itemId, Str 403 Forbidden - */ - public okhttp3.Call headMasterHlsVideoPlaylistAsync(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headMasterHlsVideoPlaylistAsync(UUID itemId, String mediaSourceId, Boolean _static, String params, String tag, String deviceProfileId, String playSessionId, String segmentContainer, Integer segmentLength, Integer minSegments, String deviceId, String audioCodec, Boolean enableAutoStreamCopy, Boolean allowVideoStreamCopy, Boolean allowAudioStreamCopy, Boolean breakOnNonKeyFrames, Integer audioSampleRate, Integer maxAudioBitDepth, Integer audioBitRate, Integer audioChannels, Integer maxAudioChannels, String profile, String level, Float framerate, Float maxFramerate, Boolean copyTimestamps, Long startTimeTicks, Integer width, Integer height, Integer maxWidth, Integer maxHeight, Integer videoBitRate, Integer subtitleStreamIndex, SubtitleDeliveryMethod subtitleMethod, Integer maxRefFrames, Integer maxVideoBitDepth, Boolean requireAvc, Boolean deInterlace, Boolean requireNonAnamorphic, Integer transcodingMaxAudioChannels, Integer cpuCoreLimit, String liveStreamId, Boolean enableMpegtsM2TsMode, String videoCodec, String subtitleCodec, String transcodeReasons, Integer audioStreamIndex, Integer videoStreamIndex, EncodingContext context, Map streamOptions, Boolean enableAdaptiveBitrateStreaming, Boolean enableTrickplay, Boolean enableAudioVbrEncoding, Boolean alwaysBurnInSubtitleWhenTranscoding, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headMasterHlsVideoPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, _callback); + okhttp3.Call localVarCall = headMasterHlsVideoPlaylistValidateBeforeCall(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/EnvironmentApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/EnvironmentApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/EnvironmentApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/EnvironmentApi.java index f631e6e8b2084..65be9e3c4c00c 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/EnvironmentApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/EnvironmentApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/FilterApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/FilterApi.java similarity index 97% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/FilterApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/FilterApi.java index 5b63f1643a5aa..5a46131af332f 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/FilterApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/FilterApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -28,6 +28,7 @@ import org.openapitools.client.model.BaseItemKind; +import org.openapitools.client.model.MediaType; import org.openapitools.client.model.QueryFilters; import org.openapitools.client.model.QueryFiltersLegacy; import java.util.UUID; @@ -300,7 +301,7 @@ public okhttp3.Call getQueryFiltersAsync(UUID userId, UUID parentId, List 403 Forbidden - */ - public okhttp3.Call getQueryFiltersLegacyCall(UUID userId, UUID parentId, List includeItemTypes, List mediaTypes, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getQueryFiltersLegacyCall(UUID userId, UUID parentId, List includeItemTypes, List mediaTypes, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -363,7 +364,7 @@ public okhttp3.Call getQueryFiltersLegacyCall(UUID userId, UUID parentId, List includeItemTypes, List mediaTypes, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getQueryFiltersLegacyValidateBeforeCall(UUID userId, UUID parentId, List includeItemTypes, List mediaTypes, final ApiCallback _callback) throws ApiException { return getQueryFiltersLegacyCall(userId, parentId, includeItemTypes, mediaTypes, _callback); } @@ -386,7 +387,7 @@ private okhttp3.Call getQueryFiltersLegacyValidateBeforeCall(UUID userId, UUID p 403 Forbidden - */ - public QueryFiltersLegacy getQueryFiltersLegacy(UUID userId, UUID parentId, List includeItemTypes, List mediaTypes) throws ApiException { + public QueryFiltersLegacy getQueryFiltersLegacy(UUID userId, UUID parentId, List includeItemTypes, List mediaTypes) throws ApiException { ApiResponse localVarResp = getQueryFiltersLegacyWithHttpInfo(userId, parentId, includeItemTypes, mediaTypes); return localVarResp.getData(); } @@ -409,7 +410,7 @@ public QueryFiltersLegacy getQueryFiltersLegacy(UUID userId, UUID parentId, List 403 Forbidden - */ - public ApiResponse getQueryFiltersLegacyWithHttpInfo(UUID userId, UUID parentId, List includeItemTypes, List mediaTypes) throws ApiException { + public ApiResponse getQueryFiltersLegacyWithHttpInfo(UUID userId, UUID parentId, List includeItemTypes, List mediaTypes) throws ApiException { okhttp3.Call localVarCall = getQueryFiltersLegacyValidateBeforeCall(userId, parentId, includeItemTypes, mediaTypes, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); @@ -434,7 +435,7 @@ public ApiResponse getQueryFiltersLegacyWithHttpInfo(UUID us 403 Forbidden - */ - public okhttp3.Call getQueryFiltersLegacyAsync(UUID userId, UUID parentId, List includeItemTypes, List mediaTypes, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getQueryFiltersLegacyAsync(UUID userId, UUID parentId, List includeItemTypes, List mediaTypes, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getQueryFiltersLegacyValidateBeforeCall(userId, parentId, includeItemTypes, mediaTypes, _callback); Type localVarReturnType = new TypeToken(){}.getType(); diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/GenresApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/GenresApi.java similarity index 96% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/GenresApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/GenresApi.java index dacca0bb2c69a..850d9147ea3b8 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/GenresApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/GenresApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -32,6 +32,7 @@ import org.openapitools.client.model.BaseItemKind; import org.openapitools.client.model.ImageType; import org.openapitools.client.model.ItemFields; +import org.openapitools.client.model.ItemSortBy; import org.openapitools.client.model.SortOrder; import java.util.UUID; @@ -255,7 +256,7 @@ public okhttp3.Call getGenreAsync(String genreName, UUID userId, final ApiCallba 403 Forbidden - */ - public okhttp3.Call getGenresCall(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getGenresCall(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -374,7 +375,7 @@ public okhttp3.Call getGenresCall(Integer startIndex, Integer limit, String sear } @SuppressWarnings("rawtypes") - private okhttp3.Call getGenresValidateBeforeCall(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getGenresValidateBeforeCall(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { return getGenresCall(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, _callback); } @@ -411,7 +412,7 @@ private okhttp3.Call getGenresValidateBeforeCall(Integer startIndex, Integer lim 403 Forbidden - */ - public BaseItemDtoQueryResult getGenres(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { + public BaseItemDtoQueryResult getGenres(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { ApiResponse localVarResp = getGenresWithHttpInfo(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount); return localVarResp.getData(); } @@ -448,7 +449,7 @@ public BaseItemDtoQueryResult getGenres(Integer startIndex, Integer limit, Strin 403 Forbidden - */ - public ApiResponse getGenresWithHttpInfo(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { + public ApiResponse getGenresWithHttpInfo(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { okhttp3.Call localVarCall = getGenresValidateBeforeCall(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); @@ -487,7 +488,7 @@ public ApiResponse getGenresWithHttpInfo(Integer startIn 403 Forbidden - */ - public okhttp3.Call getGenresAsync(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getGenresAsync(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getGenresValidateBeforeCall(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, _callback); Type localVarReturnType = new TypeToken(){}.getType(); diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/HlsSegmentApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/HlsSegmentApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/HlsSegmentApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/HlsSegmentApi.java index e7a878a788488..07eba2044cc44 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/HlsSegmentApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/HlsSegmentApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ImageApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ImageApi.java similarity index 77% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ImageApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ImageApi.java index e9d845a9ca6aa..a5fb3bbe2df91 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ImageApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ImageApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -511,9 +511,7 @@ public okhttp3.Call deleteItemImageByIndexAsync(UUID itemId, ImageType imageType } /** * Build call for deleteUserImage - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (optional) + * @param userId User Id. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -526,7 +524,7 @@ public okhttp3.Call deleteItemImageByIndexAsync(UUID itemId, ImageType imageType 401 Unauthorized - */ - public okhttp3.Call deleteUserImageCall(UUID userId, ImageType imageType, Integer index, final ApiCallback _callback) throws ApiException { + public okhttp3.Call deleteUserImageCall(UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -543,9 +541,7 @@ public okhttp3.Call deleteUserImageCall(UUID userId, ImageType imageType, Intege Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/Images/{imageType}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())); + String localVarPath = "/UserImage"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -553,158 +549,10 @@ public okhttp3.Call deleteUserImageCall(UUID userId, ImageType imageType, Intege Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); - if (index != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("index", index)); - } - - final String[] localVarAccepts = { - "application/json", - "application/json; profile=CamelCase", - "application/json; profile=PascalCase" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - if (localVarContentType != null) { - localVarHeaderParams.put("Content-Type", localVarContentType); - } - - String[] localVarAuthNames = new String[] { "CustomAuthentication" }; - return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call deleteUserImageValidateBeforeCall(UUID userId, ImageType imageType, Integer index, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling deleteUserImage(Async)"); - } - - // verify the required parameter 'imageType' is set - if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling deleteUserImage(Async)"); - } - - return deleteUserImageCall(userId, imageType, index, _callback); - - } - - /** - * Delete the user's image. - * - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (optional) - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
204 Image deleted. -
403 User does not have permission to delete the image. -
401 Unauthorized -
- */ - public void deleteUserImage(UUID userId, ImageType imageType, Integer index) throws ApiException { - deleteUserImageWithHttpInfo(userId, imageType, index); - } - - /** - * Delete the user's image. - * - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (optional) - * @return ApiResponse<Void> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
204 Image deleted. -
403 User does not have permission to delete the image. -
401 Unauthorized -
- */ - public ApiResponse deleteUserImageWithHttpInfo(UUID userId, ImageType imageType, Integer index) throws ApiException { - okhttp3.Call localVarCall = deleteUserImageValidateBeforeCall(userId, imageType, index, null); - return localVarApiClient.execute(localVarCall); - } - - /** - * Delete the user's image. (asynchronously) - * - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (optional) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
204 Image deleted. -
403 User does not have permission to delete the image. -
401 Unauthorized -
- */ - public okhttp3.Call deleteUserImageAsync(UUID userId, ImageType imageType, Integer index, final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = deleteUserImageValidateBeforeCall(userId, imageType, index, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); - return localVarCall; - } - /** - * Build call for deleteUserImageByIndex - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
204 Image deleted. -
403 User does not have permission to delete the image. -
401 Unauthorized -
- */ - public okhttp3.Call deleteUserImageByIndexCall(UUID userId, ImageType imageType, Integer index, final ApiCallback _callback) throws ApiException { - String basePath = null; - // Operation Servers - String[] localBasePaths = new String[] { }; - - // Determine Base Path to Use - if (localCustomBaseUrl != null){ - basePath = localCustomBaseUrl; - } else if ( localBasePaths.length > 0 ) { - basePath = localBasePaths[localHostIndex]; - } else { - basePath = null; + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); } - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/Users/{userId}/Images/{imageType}/{index}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) - .replace("{" + "index" + "}", localVarApiClient.escapeString(index.toString())); - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -727,32 +575,15 @@ public okhttp3.Call deleteUserImageByIndexCall(UUID userId, ImageType imageType, } @SuppressWarnings("rawtypes") - private okhttp3.Call deleteUserImageByIndexValidateBeforeCall(UUID userId, ImageType imageType, Integer index, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling deleteUserImageByIndex(Async)"); - } - - // verify the required parameter 'imageType' is set - if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling deleteUserImageByIndex(Async)"); - } - - // verify the required parameter 'index' is set - if (index == null) { - throw new ApiException("Missing the required parameter 'index' when calling deleteUserImageByIndex(Async)"); - } - - return deleteUserImageByIndexCall(userId, imageType, index, _callback); + private okhttp3.Call deleteUserImageValidateBeforeCall(UUID userId, final ApiCallback _callback) throws ApiException { + return deleteUserImageCall(userId, _callback); } /** * Delete the user's image. * - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (required) + * @param userId User Id. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -763,16 +594,14 @@ private okhttp3.Call deleteUserImageByIndexValidateBeforeCall(UUID userId, Image
401 Unauthorized -
*/ - public void deleteUserImageByIndex(UUID userId, ImageType imageType, Integer index) throws ApiException { - deleteUserImageByIndexWithHttpInfo(userId, imageType, index); + public void deleteUserImage(UUID userId) throws ApiException { + deleteUserImageWithHttpInfo(userId); } /** * Delete the user's image. * - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (required) + * @param userId User Id. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -784,17 +613,15 @@ public void deleteUserImageByIndex(UUID userId, ImageType imageType, Integer ind 401 Unauthorized - */ - public ApiResponse deleteUserImageByIndexWithHttpInfo(UUID userId, ImageType imageType, Integer index) throws ApiException { - okhttp3.Call localVarCall = deleteUserImageByIndexValidateBeforeCall(userId, imageType, index, null); + public ApiResponse deleteUserImageWithHttpInfo(UUID userId) throws ApiException { + okhttp3.Call localVarCall = deleteUserImageValidateBeforeCall(userId, null); return localVarApiClient.execute(localVarCall); } /** * Delete the user's image. (asynchronously) * - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (required) + * @param userId User Id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -807,9 +634,9 @@ public ApiResponse deleteUserImageByIndexWithHttpInfo(UUID userId, ImageTy 401 Unauthorized - */ - public okhttp3.Call deleteUserImageByIndexAsync(UUID userId, ImageType imageType, Integer index, final ApiCallback _callback) throws ApiException { + public okhttp3.Call deleteUserImageAsync(UUID userId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = deleteUserImageByIndexValidateBeforeCall(userId, imageType, index, _callback); + okhttp3.Call localVarCall = deleteUserImageValidateBeforeCall(userId, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } @@ -829,8 +656,6 @@ public okhttp3.Call deleteUserImageByIndexAsync(UUID userId, ImageType imageType * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -845,7 +670,7 @@ public okhttp3.Call deleteUserImageByIndexAsync(UUID userId, ImageType imageType 404 Item not found. - */ - public okhttp3.Call getArtistImageCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getArtistImageCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -917,14 +742,6 @@ public okhttp3.Call getArtistImageCall(String name, ImageType imageType, Integer localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -960,7 +777,7 @@ public okhttp3.Call getArtistImageCall(String name, ImageType imageType, Integer } @SuppressWarnings("rawtypes") - private okhttp3.Call getArtistImageValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getArtistImageValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { throw new ApiException("Missing the required parameter 'name' when calling getArtistImage(Async)"); @@ -976,7 +793,7 @@ private okhttp3.Call getArtistImageValidateBeforeCall(String name, ImageType ima throw new ApiException("Missing the required parameter 'imageIndex' when calling getArtistImage(Async)"); } - return getArtistImageCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + return getArtistImageCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); } @@ -997,8 +814,6 @@ private okhttp3.Call getArtistImageValidateBeforeCall(String name, ImageType ima * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -1012,8 +827,8 @@ private okhttp3.Call getArtistImageValidateBeforeCall(String name, ImageType ima 404 Item not found. - */ - public File getArtistImage(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = getArtistImageWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer); + public File getArtistImage(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + ApiResponse localVarResp = getArtistImageWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); return localVarResp.getData(); } @@ -1034,8 +849,6 @@ public File getArtistImage(String name, ImageType imageType, Integer imageIndex, * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -1049,8 +862,8 @@ public File getArtistImage(String name, ImageType imageType, Integer imageIndex, 404 Item not found. - */ - public ApiResponse getArtistImageWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = getArtistImageValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, null); + public ApiResponse getArtistImageWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + okhttp3.Call localVarCall = getArtistImageValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -1072,8 +885,6 @@ public ApiResponse getArtistImageWithHttpInfo(String name, ImageType image * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -1088,9 +899,9 @@ public ApiResponse getArtistImageWithHttpInfo(String name, ImageType image 404 Item not found. - */ - public okhttp3.Call getArtistImageAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getArtistImageAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getArtistImageValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + okhttp3.Call localVarCall = getArtistImageValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -1110,8 +921,6 @@ public okhttp3.Call getArtistImageAsync(String name, ImageType imageType, Intege * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -1127,7 +936,7 @@ public okhttp3.Call getArtistImageAsync(String name, ImageType imageType, Intege 404 Item not found. - */ - public okhttp3.Call getGenreImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getGenreImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1198,14 +1007,6 @@ public okhttp3.Call getGenreImageCall(String name, ImageType imageType, String t localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -1245,7 +1046,7 @@ public okhttp3.Call getGenreImageCall(String name, ImageType imageType, String t } @SuppressWarnings("rawtypes") - private okhttp3.Call getGenreImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getGenreImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { throw new ApiException("Missing the required parameter 'name' when calling getGenreImage(Async)"); @@ -1256,7 +1057,7 @@ private okhttp3.Call getGenreImageValidateBeforeCall(String name, ImageType imag throw new ApiException("Missing the required parameter 'imageType' when calling getGenreImage(Async)"); } - return getGenreImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + return getGenreImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); } @@ -1276,8 +1077,6 @@ private okhttp3.Call getGenreImageValidateBeforeCall(String name, ImageType imag * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -1292,8 +1091,8 @@ private okhttp3.Call getGenreImageValidateBeforeCall(String name, ImageType imag 404 Item not found. - */ - public File getGenreImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - ApiResponse localVarResp = getGenreImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex); + public File getGenreImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + ApiResponse localVarResp = getGenreImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); return localVarResp.getData(); } @@ -1313,8 +1112,6 @@ public File getGenreImage(String name, ImageType imageType, String tag, ImageFor * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -1329,8 +1126,8 @@ public File getGenreImage(String name, ImageType imageType, String tag, ImageFor 404 Item not found. - */ - public ApiResponse getGenreImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - okhttp3.Call localVarCall = getGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, null); + public ApiResponse getGenreImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + okhttp3.Call localVarCall = getGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -1351,8 +1148,6 @@ public ApiResponse getGenreImageWithHttpInfo(String name, ImageType imageT * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -1368,9 +1163,9 @@ public ApiResponse getGenreImageWithHttpInfo(String name, ImageType imageT 404 Item not found. - */ - public okhttp3.Call getGenreImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getGenreImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + okhttp3.Call localVarCall = getGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -1391,8 +1186,6 @@ public okhttp3.Call getGenreImageAsync(String name, ImageType imageType, String * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -1407,7 +1200,7 @@ public okhttp3.Call getGenreImageAsync(String name, ImageType imageType, String 404 Item not found. - */ - public okhttp3.Call getGenreImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getGenreImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1479,14 +1272,6 @@ public okhttp3.Call getGenreImageByIndexCall(String name, ImageType imageType, I localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -1522,7 +1307,7 @@ public okhttp3.Call getGenreImageByIndexCall(String name, ImageType imageType, I } @SuppressWarnings("rawtypes") - private okhttp3.Call getGenreImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getGenreImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { throw new ApiException("Missing the required parameter 'name' when calling getGenreImageByIndex(Async)"); @@ -1538,7 +1323,7 @@ private okhttp3.Call getGenreImageByIndexValidateBeforeCall(String name, ImageTy throw new ApiException("Missing the required parameter 'imageIndex' when calling getGenreImageByIndex(Async)"); } - return getGenreImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + return getGenreImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); } @@ -1559,8 +1344,6 @@ private okhttp3.Call getGenreImageByIndexValidateBeforeCall(String name, ImageTy * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -1574,8 +1357,8 @@ private okhttp3.Call getGenreImageByIndexValidateBeforeCall(String name, ImageTy 404 Item not found. - */ - public File getGenreImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = getGenreImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer); + public File getGenreImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + ApiResponse localVarResp = getGenreImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); return localVarResp.getData(); } @@ -1596,8 +1379,6 @@ public File getGenreImageByIndex(String name, ImageType imageType, Integer image * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -1611,8 +1392,8 @@ public File getGenreImageByIndex(String name, ImageType imageType, Integer image 404 Item not found. - */ - public ApiResponse getGenreImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = getGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, null); + public ApiResponse getGenreImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + okhttp3.Call localVarCall = getGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -1634,8 +1415,6 @@ public ApiResponse getGenreImageByIndexWithHttpInfo(String name, ImageType * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -1650,9 +1429,9 @@ public ApiResponse getGenreImageByIndexWithHttpInfo(String name, ImageType 404 Item not found. - */ - public okhttp3.Call getGenreImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getGenreImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + okhttp3.Call localVarCall = getGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -1669,9 +1448,7 @@ public okhttp3.Call getGenreImageByIndexAsync(String name, ImageType imageType, * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) @@ -1689,7 +1466,7 @@ public okhttp3.Call getGenreImageByIndexAsync(String name, ImageType imageType, 404 Item not found. - */ - public okhttp3.Call getItemImageCall(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getItemImageCall(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1748,18 +1525,10 @@ public okhttp3.Call getItemImageCall(UUID itemId, ImageType imageType, Integer m localVarQueryParams.addAll(localVarApiClient.parameterToPair("tag", tag)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - if (format != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("format", format)); } - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (percentPlayed != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("percentPlayed", percentPlayed)); } @@ -1807,7 +1576,7 @@ public okhttp3.Call getItemImageCall(UUID itemId, ImageType imageType, Integer m } @SuppressWarnings("rawtypes") - private okhttp3.Call getItemImageValidateBeforeCall(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getItemImageValidateBeforeCall(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getItemImage(Async)"); @@ -1818,7 +1587,7 @@ private okhttp3.Call getItemImageValidateBeforeCall(UUID itemId, ImageType image throw new ApiException("Missing the required parameter 'imageType' when calling getItemImage(Async)"); } - return getItemImageCall(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + return getItemImageCall(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, _callback); } @@ -1835,9 +1604,7 @@ private okhttp3.Call getItemImageValidateBeforeCall(UUID itemId, ImageType image * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) @@ -1854,8 +1621,8 @@ private okhttp3.Call getItemImageValidateBeforeCall(UUID itemId, ImageType image 404 Item not found. - */ - public File getItemImage(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - ApiResponse localVarResp = getItemImageWithHttpInfo(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex); + public File getItemImage(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + ApiResponse localVarResp = getItemImageWithHttpInfo(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex); return localVarResp.getData(); } @@ -1872,9 +1639,7 @@ public File getItemImage(UUID itemId, ImageType imageType, Integer maxWidth, Int * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) @@ -1891,8 +1656,8 @@ public File getItemImage(UUID itemId, ImageType imageType, Integer maxWidth, Int 404 Item not found. - */ - public ApiResponse getItemImageWithHttpInfo(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - okhttp3.Call localVarCall = getItemImageValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, null); + public ApiResponse getItemImageWithHttpInfo(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + okhttp3.Call localVarCall = getItemImageValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -1910,9 +1675,7 @@ public ApiResponse getItemImageWithHttpInfo(UUID itemId, ImageType imageTy * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) @@ -1930,9 +1693,9 @@ public ApiResponse getItemImageWithHttpInfo(UUID itemId, ImageType imageTy 404 Item not found. - */ - public okhttp3.Call getItemImageAsync(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getItemImageAsync(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getItemImageValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + okhttp3.Call localVarCall = getItemImageValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -1953,8 +1716,6 @@ public okhttp3.Call getItemImageAsync(UUID itemId, ImageType imageType, Integer * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -1969,7 +1730,7 @@ public okhttp3.Call getItemImageAsync(UUID itemId, ImageType imageType, Integer 404 Item not found. - */ - public okhttp3.Call getItemImage2Call(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getItemImage2Call(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -2023,14 +1784,6 @@ public okhttp3.Call getItemImage2Call(UUID itemId, ImageType imageType, Integer localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -2066,7 +1819,7 @@ public okhttp3.Call getItemImage2Call(UUID itemId, ImageType imageType, Integer } @SuppressWarnings("rawtypes") - private okhttp3.Call getItemImage2ValidateBeforeCall(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getItemImage2ValidateBeforeCall(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getItemImage2(Async)"); @@ -2112,7 +1865,7 @@ private okhttp3.Call getItemImage2ValidateBeforeCall(UUID itemId, ImageType imag throw new ApiException("Missing the required parameter 'imageIndex' when calling getItemImage2(Async)"); } - return getItemImage2Call(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + return getItemImage2Call(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); } @@ -2133,8 +1886,6 @@ private okhttp3.Call getItemImage2ValidateBeforeCall(UUID itemId, ImageType imag * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -2148,8 +1899,8 @@ private okhttp3.Call getItemImage2ValidateBeforeCall(UUID itemId, ImageType imag 404 Item not found. - */ - public File getItemImage2(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = getItemImage2WithHttpInfo(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer); + public File getItemImage2(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + ApiResponse localVarResp = getItemImage2WithHttpInfo(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); return localVarResp.getData(); } @@ -2170,8 +1921,6 @@ public File getItemImage2(UUID itemId, ImageType imageType, Integer maxWidth, In * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -2185,8 +1934,8 @@ public File getItemImage2(UUID itemId, ImageType imageType, Integer maxWidth, In 404 Item not found. - */ - public ApiResponse getItemImage2WithHttpInfo(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = getItemImage2ValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, null); + public ApiResponse getItemImage2WithHttpInfo(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + okhttp3.Call localVarCall = getItemImage2ValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -2208,8 +1957,6 @@ public ApiResponse getItemImage2WithHttpInfo(UUID itemId, ImageType imageT * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -2224,9 +1971,9 @@ public ApiResponse getItemImage2WithHttpInfo(UUID itemId, ImageType imageT 404 Item not found. - */ - public okhttp3.Call getItemImage2Async(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getItemImage2Async(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getItemImage2ValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + okhttp3.Call localVarCall = getItemImage2ValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -2244,9 +1991,7 @@ public okhttp3.Call getItemImage2Async(UUID itemId, ImageType imageType, Integer * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) @@ -2263,7 +2008,7 @@ public okhttp3.Call getItemImage2Async(UUID itemId, ImageType imageType, Integer 404 Item not found. - */ - public okhttp3.Call getItemImageByIndexCall(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getItemImageByIndexCall(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -2323,18 +2068,10 @@ public okhttp3.Call getItemImageByIndexCall(UUID itemId, ImageType imageType, In localVarQueryParams.addAll(localVarApiClient.parameterToPair("tag", tag)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - if (format != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("format", format)); } - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (percentPlayed != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("percentPlayed", percentPlayed)); } @@ -2378,7 +2115,7 @@ public okhttp3.Call getItemImageByIndexCall(UUID itemId, ImageType imageType, In } @SuppressWarnings("rawtypes") - private okhttp3.Call getItemImageByIndexValidateBeforeCall(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getItemImageByIndexValidateBeforeCall(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getItemImageByIndex(Async)"); @@ -2394,7 +2131,7 @@ private okhttp3.Call getItemImageByIndexValidateBeforeCall(UUID itemId, ImageTyp throw new ApiException("Missing the required parameter 'imageIndex' when calling getItemImageByIndex(Async)"); } - return getItemImageByIndexCall(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, _callback); + return getItemImageByIndexCall(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, _callback); } @@ -2412,9 +2149,7 @@ private okhttp3.Call getItemImageByIndexValidateBeforeCall(UUID itemId, ImageTyp * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) @@ -2430,8 +2165,8 @@ private okhttp3.Call getItemImageByIndexValidateBeforeCall(UUID itemId, ImageTyp 404 Item not found. - */ - public File getItemImageByIndex(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = getItemImageByIndexWithHttpInfo(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer); + public File getItemImageByIndex(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + ApiResponse localVarResp = getItemImageByIndexWithHttpInfo(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer); return localVarResp.getData(); } @@ -2449,9 +2184,7 @@ public File getItemImageByIndex(UUID itemId, ImageType imageType, Integer imageI * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) @@ -2467,8 +2200,8 @@ public File getItemImageByIndex(UUID itemId, ImageType imageType, Integer imageI 404 Item not found. - */ - public ApiResponse getItemImageByIndexWithHttpInfo(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = getItemImageByIndexValidateBeforeCall(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, null); + public ApiResponse getItemImageByIndexWithHttpInfo(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + okhttp3.Call localVarCall = getItemImageByIndexValidateBeforeCall(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -2487,9 +2220,7 @@ public ApiResponse getItemImageByIndexWithHttpInfo(UUID itemId, ImageType * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) @@ -2506,9 +2237,9 @@ public ApiResponse getItemImageByIndexWithHttpInfo(UUID itemId, ImageType 404 Item not found. - */ - public okhttp3.Call getItemImageByIndexAsync(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getItemImageByIndexAsync(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getItemImageByIndexValidateBeforeCall(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, _callback); + okhttp3.Call localVarCall = getItemImageByIndexValidateBeforeCall(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -2669,8 +2400,6 @@ public okhttp3.Call getItemImageInfosAsync(UUID itemId, final ApiCallback 404 Item not found. - */ - public okhttp3.Call getMusicGenreImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getMusicGenreImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -2757,14 +2486,6 @@ public okhttp3.Call getMusicGenreImageCall(String name, ImageType imageType, Str localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -2804,7 +2525,7 @@ public okhttp3.Call getMusicGenreImageCall(String name, ImageType imageType, Str } @SuppressWarnings("rawtypes") - private okhttp3.Call getMusicGenreImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getMusicGenreImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { throw new ApiException("Missing the required parameter 'name' when calling getMusicGenreImage(Async)"); @@ -2815,7 +2536,7 @@ private okhttp3.Call getMusicGenreImageValidateBeforeCall(String name, ImageType throw new ApiException("Missing the required parameter 'imageType' when calling getMusicGenreImage(Async)"); } - return getMusicGenreImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + return getMusicGenreImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); } @@ -2835,8 +2556,6 @@ private okhttp3.Call getMusicGenreImageValidateBeforeCall(String name, ImageType * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -2851,8 +2570,8 @@ private okhttp3.Call getMusicGenreImageValidateBeforeCall(String name, ImageType 404 Item not found. - */ - public File getMusicGenreImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - ApiResponse localVarResp = getMusicGenreImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex); + public File getMusicGenreImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + ApiResponse localVarResp = getMusicGenreImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); return localVarResp.getData(); } @@ -2872,8 +2591,6 @@ public File getMusicGenreImage(String name, ImageType imageType, String tag, Ima * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -2888,8 +2605,8 @@ public File getMusicGenreImage(String name, ImageType imageType, String tag, Ima 404 Item not found. - */ - public ApiResponse getMusicGenreImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - okhttp3.Call localVarCall = getMusicGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, null); + public ApiResponse getMusicGenreImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + okhttp3.Call localVarCall = getMusicGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -2910,8 +2627,6 @@ public ApiResponse getMusicGenreImageWithHttpInfo(String name, ImageType i * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -2927,9 +2642,9 @@ public ApiResponse getMusicGenreImageWithHttpInfo(String name, ImageType i 404 Item not found. - */ - public okhttp3.Call getMusicGenreImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getMusicGenreImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getMusicGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + okhttp3.Call localVarCall = getMusicGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -2950,8 +2665,6 @@ public okhttp3.Call getMusicGenreImageAsync(String name, ImageType imageType, St * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -2966,7 +2679,7 @@ public okhttp3.Call getMusicGenreImageAsync(String name, ImageType imageType, St 404 Item not found. - */ - public okhttp3.Call getMusicGenreImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getMusicGenreImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -3038,14 +2751,6 @@ public okhttp3.Call getMusicGenreImageByIndexCall(String name, ImageType imageTy localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -3081,7 +2786,7 @@ public okhttp3.Call getMusicGenreImageByIndexCall(String name, ImageType imageTy } @SuppressWarnings("rawtypes") - private okhttp3.Call getMusicGenreImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getMusicGenreImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { throw new ApiException("Missing the required parameter 'name' when calling getMusicGenreImageByIndex(Async)"); @@ -3097,7 +2802,7 @@ private okhttp3.Call getMusicGenreImageByIndexValidateBeforeCall(String name, Im throw new ApiException("Missing the required parameter 'imageIndex' when calling getMusicGenreImageByIndex(Async)"); } - return getMusicGenreImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + return getMusicGenreImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); } @@ -3118,8 +2823,6 @@ private okhttp3.Call getMusicGenreImageByIndexValidateBeforeCall(String name, Im * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -3133,8 +2836,8 @@ private okhttp3.Call getMusicGenreImageByIndexValidateBeforeCall(String name, Im 404 Item not found. - */ - public File getMusicGenreImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = getMusicGenreImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer); + public File getMusicGenreImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + ApiResponse localVarResp = getMusicGenreImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); return localVarResp.getData(); } @@ -3155,8 +2858,6 @@ public File getMusicGenreImageByIndex(String name, ImageType imageType, Integer * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -3170,8 +2871,8 @@ public File getMusicGenreImageByIndex(String name, ImageType imageType, Integer 404 Item not found. - */ - public ApiResponse getMusicGenreImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = getMusicGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, null); + public ApiResponse getMusicGenreImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + okhttp3.Call localVarCall = getMusicGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -3193,8 +2894,6 @@ public ApiResponse getMusicGenreImageByIndexWithHttpInfo(String name, Imag * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -3209,9 +2908,9 @@ public ApiResponse getMusicGenreImageByIndexWithHttpInfo(String name, Imag 404 Item not found. - */ - public okhttp3.Call getMusicGenreImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getMusicGenreImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getMusicGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + okhttp3.Call localVarCall = getMusicGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -3231,8 +2930,6 @@ public okhttp3.Call getMusicGenreImageByIndexAsync(String name, ImageType imageT * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -3248,7 +2945,7 @@ public okhttp3.Call getMusicGenreImageByIndexAsync(String name, ImageType imageT 404 Item not found. - */ - public okhttp3.Call getPersonImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getPersonImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -3319,14 +3016,6 @@ public okhttp3.Call getPersonImageCall(String name, ImageType imageType, String localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -3366,7 +3055,7 @@ public okhttp3.Call getPersonImageCall(String name, ImageType imageType, String } @SuppressWarnings("rawtypes") - private okhttp3.Call getPersonImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getPersonImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { throw new ApiException("Missing the required parameter 'name' when calling getPersonImage(Async)"); @@ -3377,7 +3066,7 @@ private okhttp3.Call getPersonImageValidateBeforeCall(String name, ImageType ima throw new ApiException("Missing the required parameter 'imageType' when calling getPersonImage(Async)"); } - return getPersonImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + return getPersonImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); } @@ -3397,8 +3086,6 @@ private okhttp3.Call getPersonImageValidateBeforeCall(String name, ImageType ima * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -3413,8 +3100,8 @@ private okhttp3.Call getPersonImageValidateBeforeCall(String name, ImageType ima 404 Item not found. - */ - public File getPersonImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - ApiResponse localVarResp = getPersonImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex); + public File getPersonImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + ApiResponse localVarResp = getPersonImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); return localVarResp.getData(); } @@ -3434,8 +3121,6 @@ public File getPersonImage(String name, ImageType imageType, String tag, ImageFo * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -3450,8 +3135,8 @@ public File getPersonImage(String name, ImageType imageType, String tag, ImageFo 404 Item not found. - */ - public ApiResponse getPersonImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - okhttp3.Call localVarCall = getPersonImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, null); + public ApiResponse getPersonImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + okhttp3.Call localVarCall = getPersonImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -3472,8 +3157,6 @@ public ApiResponse getPersonImageWithHttpInfo(String name, ImageType image * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -3489,9 +3172,9 @@ public ApiResponse getPersonImageWithHttpInfo(String name, ImageType image 404 Item not found. - */ - public okhttp3.Call getPersonImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getPersonImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getPersonImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + okhttp3.Call localVarCall = getPersonImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -3512,8 +3195,6 @@ public okhttp3.Call getPersonImageAsync(String name, ImageType imageType, String * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -3528,7 +3209,7 @@ public okhttp3.Call getPersonImageAsync(String name, ImageType imageType, String 404 Item not found. - */ - public okhttp3.Call getPersonImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getPersonImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -3600,14 +3281,6 @@ public okhttp3.Call getPersonImageByIndexCall(String name, ImageType imageType, localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -3643,7 +3316,7 @@ public okhttp3.Call getPersonImageByIndexCall(String name, ImageType imageType, } @SuppressWarnings("rawtypes") - private okhttp3.Call getPersonImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getPersonImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { throw new ApiException("Missing the required parameter 'name' when calling getPersonImageByIndex(Async)"); @@ -3659,7 +3332,7 @@ private okhttp3.Call getPersonImageByIndexValidateBeforeCall(String name, ImageT throw new ApiException("Missing the required parameter 'imageIndex' when calling getPersonImageByIndex(Async)"); } - return getPersonImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + return getPersonImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); } @@ -3680,8 +3353,6 @@ private okhttp3.Call getPersonImageByIndexValidateBeforeCall(String name, ImageT * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -3695,8 +3366,8 @@ private okhttp3.Call getPersonImageByIndexValidateBeforeCall(String name, ImageT 404 Item not found. - */ - public File getPersonImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = getPersonImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer); + public File getPersonImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + ApiResponse localVarResp = getPersonImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); return localVarResp.getData(); } @@ -3717,8 +3388,6 @@ public File getPersonImageByIndex(String name, ImageType imageType, Integer imag * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -3732,8 +3401,8 @@ public File getPersonImageByIndex(String name, ImageType imageType, Integer imag 404 Item not found. - */ - public ApiResponse getPersonImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = getPersonImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, null); + public ApiResponse getPersonImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + okhttp3.Call localVarCall = getPersonImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -3755,8 +3424,6 @@ public ApiResponse getPersonImageByIndexWithHttpInfo(String name, ImageTyp * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -3771,9 +3438,9 @@ public ApiResponse getPersonImageByIndexWithHttpInfo(String name, ImageTyp 404 Item not found. - */ - public okhttp3.Call getPersonImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getPersonImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getPersonImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + okhttp3.Call localVarCall = getPersonImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -4006,8 +3673,6 @@ public okhttp3.Call getSplashscreenAsync(String tag, ImageFormat format, Integer * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -4023,7 +3688,7 @@ public okhttp3.Call getSplashscreenAsync(String tag, ImageFormat format, Integer 404 Item not found. - */ - public okhttp3.Call getStudioImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getStudioImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -4094,14 +3759,6 @@ public okhttp3.Call getStudioImageCall(String name, ImageType imageType, String localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -4141,7 +3798,7 @@ public okhttp3.Call getStudioImageCall(String name, ImageType imageType, String } @SuppressWarnings("rawtypes") - private okhttp3.Call getStudioImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getStudioImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { throw new ApiException("Missing the required parameter 'name' when calling getStudioImage(Async)"); @@ -4152,7 +3809,7 @@ private okhttp3.Call getStudioImageValidateBeforeCall(String name, ImageType ima throw new ApiException("Missing the required parameter 'imageType' when calling getStudioImage(Async)"); } - return getStudioImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + return getStudioImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); } @@ -4172,8 +3829,6 @@ private okhttp3.Call getStudioImageValidateBeforeCall(String name, ImageType ima * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -4188,8 +3843,8 @@ private okhttp3.Call getStudioImageValidateBeforeCall(String name, ImageType ima 404 Item not found. - */ - public File getStudioImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - ApiResponse localVarResp = getStudioImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex); + public File getStudioImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + ApiResponse localVarResp = getStudioImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); return localVarResp.getData(); } @@ -4209,8 +3864,6 @@ public File getStudioImage(String name, ImageType imageType, String tag, ImageFo * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -4225,8 +3878,8 @@ public File getStudioImage(String name, ImageType imageType, String tag, ImageFo 404 Item not found. - */ - public ApiResponse getStudioImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - okhttp3.Call localVarCall = getStudioImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, null); + public ApiResponse getStudioImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + okhttp3.Call localVarCall = getStudioImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -4247,8 +3900,6 @@ public ApiResponse getStudioImageWithHttpInfo(String name, ImageType image * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -4264,9 +3915,9 @@ public ApiResponse getStudioImageWithHttpInfo(String name, ImageType image 404 Item not found. - */ - public okhttp3.Call getStudioImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getStudioImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getStudioImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + okhttp3.Call localVarCall = getStudioImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -4287,8 +3938,6 @@ public okhttp3.Call getStudioImageAsync(String name, ImageType imageType, String * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -4303,7 +3952,7 @@ public okhttp3.Call getStudioImageAsync(String name, ImageType imageType, String 404 Item not found. - */ - public okhttp3.Call getStudioImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getStudioImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -4375,14 +4024,6 @@ public okhttp3.Call getStudioImageByIndexCall(String name, ImageType imageType, localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -4418,7 +4059,7 @@ public okhttp3.Call getStudioImageByIndexCall(String name, ImageType imageType, } @SuppressWarnings("rawtypes") - private okhttp3.Call getStudioImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getStudioImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { throw new ApiException("Missing the required parameter 'name' when calling getStudioImageByIndex(Async)"); @@ -4434,7 +4075,7 @@ private okhttp3.Call getStudioImageByIndexValidateBeforeCall(String name, ImageT throw new ApiException("Missing the required parameter 'imageIndex' when calling getStudioImageByIndex(Async)"); } - return getStudioImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + return getStudioImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); } @@ -4455,8 +4096,6 @@ private okhttp3.Call getStudioImageByIndexValidateBeforeCall(String name, ImageT * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -4470,8 +4109,8 @@ private okhttp3.Call getStudioImageByIndexValidateBeforeCall(String name, ImageT 404 Item not found. - */ - public File getStudioImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = getStudioImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer); + public File getStudioImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + ApiResponse localVarResp = getStudioImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); return localVarResp.getData(); } @@ -4492,8 +4131,6 @@ public File getStudioImageByIndex(String name, ImageType imageType, Integer imag * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -4507,8 +4144,8 @@ public File getStudioImageByIndex(String name, ImageType imageType, Integer imag 404 Item not found. - */ - public ApiResponse getStudioImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = getStudioImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, null); + public ApiResponse getStudioImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + okhttp3.Call localVarCall = getStudioImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -4530,8 +4167,6 @@ public ApiResponse getStudioImageByIndexWithHttpInfo(String name, ImageTyp * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -4546,17 +4181,16 @@ public ApiResponse getStudioImageByIndexWithHttpInfo(String name, ImageTyp 404 Item not found. - */ - public okhttp3.Call getStudioImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getStudioImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getStudioImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + okhttp3.Call localVarCall = getStudioImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getUserImage - * @param userId User id. (required) - * @param imageType Image type. (required) + * @param userId User id. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -4568,8 +4202,6 @@ public okhttp3.Call getStudioImageByIndexAsync(String name, ImageType imageType, * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -4582,10 +4214,11 @@ public okhttp3.Call getStudioImageByIndexAsync(String name, ImageType imageType, Response Details Status Code Description Response Headers 200 Image stream returned. - + 400 User id not provided. - 404 Item not found. - */ - public okhttp3.Call getUserImageCall(UUID userId, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getUserImageCall(UUID userId, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -4602,9 +4235,7 @@ public okhttp3.Call getUserImageCall(UUID userId, ImageType imageType, String ta Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/Images/{imageType}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())); + String localVarPath = "/UserImage"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -4612,6 +4243,10 @@ public okhttp3.Call getUserImageCall(UUID userId, ImageType imageType, String ta Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + if (tag != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("tag", tag)); } @@ -4656,14 +4291,6 @@ public okhttp3.Call getUserImageCall(UUID userId, ImageType imageType, String ta localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -4703,26 +4330,15 @@ public okhttp3.Call getUserImageCall(UUID userId, ImageType imageType, String ta } @SuppressWarnings("rawtypes") - private okhttp3.Call getUserImageValidateBeforeCall(UUID userId, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling getUserImage(Async)"); - } - - // verify the required parameter 'imageType' is set - if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling getUserImage(Async)"); - } - - return getUserImageCall(userId, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + private okhttp3.Call getUserImageValidateBeforeCall(UUID userId, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + return getUserImageCall(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); } /** * Get user profile image. * - * @param userId User id. (required) - * @param imageType Image type. (required) + * @param userId User id. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -4734,8 +4350,6 @@ private okhttp3.Call getUserImageValidateBeforeCall(UUID userId, ImageType image * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -4747,19 +4361,19 @@ private okhttp3.Call getUserImageValidateBeforeCall(UUID userId, ImageType image Response Details Status Code Description Response Headers 200 Image stream returned. - + 400 User id not provided. - 404 Item not found. - */ - public File getUserImage(UUID userId, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - ApiResponse localVarResp = getUserImageWithHttpInfo(userId, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex); + public File getUserImage(UUID userId, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + ApiResponse localVarResp = getUserImageWithHttpInfo(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); return localVarResp.getData(); } /** * Get user profile image. * - * @param userId User id. (required) - * @param imageType Image type. (required) + * @param userId User id. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -4771,8 +4385,6 @@ public File getUserImage(UUID userId, ImageType imageType, String tag, ImageForm * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -4784,11 +4396,12 @@ public File getUserImage(UUID userId, ImageType imageType, String tag, ImageForm Response Details Status Code Description Response Headers 200 Image stream returned. - + 400 User id not provided. - 404 Item not found. - */ - public ApiResponse getUserImageWithHttpInfo(UUID userId, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - okhttp3.Call localVarCall = getUserImageValidateBeforeCall(userId, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, null); + public ApiResponse getUserImageWithHttpInfo(UUID userId, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + okhttp3.Call localVarCall = getUserImageValidateBeforeCall(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -4796,8 +4409,7 @@ public ApiResponse getUserImageWithHttpInfo(UUID userId, ImageType imageTy /** * Get user profile image. (asynchronously) * - * @param userId User id. (required) - * @param imageType Image type. (required) + * @param userId User id. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -4809,8 +4421,6 @@ public ApiResponse getUserImageWithHttpInfo(UUID userId, ImageType imageTy * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -4823,19 +4433,20 @@ public ApiResponse getUserImageWithHttpInfo(UUID userId, ImageType imageTy Response Details Status Code Description Response Headers 200 Image stream returned. - + 400 User id not provided. - 404 Item not found. - */ - public okhttp3.Call getUserImageAsync(UUID userId, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getUserImageAsync(UUID userId, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getUserImageValidateBeforeCall(userId, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + okhttp3.Call localVarCall = getUserImageValidateBeforeCall(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for getUserImageByIndex - * @param userId User id. (required) + * Build call for headArtistImage + * @param name Artist name. (required) * @param imageType Image type. (required) * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) @@ -4849,8 +4460,6 @@ public okhttp3.Call getUserImageAsync(UUID userId, ImageType imageType, String t * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -4865,7 +4474,7 @@ public okhttp3.Call getUserImageAsync(UUID userId, ImageType imageType, String t 404 Item not found. - */ - public okhttp3.Call getUserImageByIndexCall(UUID userId, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headArtistImageCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -4882,8 +4491,8 @@ public okhttp3.Call getUserImageByIndexCall(UUID userId, ImageType imageType, In Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/Images/{imageType}/{imageIndex}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) + String localVarPath = "/Artists/{name}/Images/{imageType}/{imageIndex}" + .replace("{" + "name" + "}", localVarApiClient.escapeString(name.toString())) .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) .replace("{" + "imageIndex" + "}", localVarApiClient.escapeString(imageIndex.toString())); @@ -4937,14 +4546,6 @@ public okhttp3.Call getUserImageByIndexCall(UUID userId, ImageType imageType, In localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -4976,34 +4577,34 @@ public okhttp3.Call getUserImageByIndexCall(UUID userId, ImageType imageType, In } String[] localVarAuthNames = new String[] { }; - return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + return localVarApiClient.buildCall(basePath, localVarPath, "HEAD", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") - private okhttp3.Call getUserImageByIndexValidateBeforeCall(UUID userId, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling getUserImageByIndex(Async)"); + private okhttp3.Call headArtistImageValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'name' is set + if (name == null) { + throw new ApiException("Missing the required parameter 'name' when calling headArtistImage(Async)"); } // verify the required parameter 'imageType' is set if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling getUserImageByIndex(Async)"); + throw new ApiException("Missing the required parameter 'imageType' when calling headArtistImage(Async)"); } // verify the required parameter 'imageIndex' is set if (imageIndex == null) { - throw new ApiException("Missing the required parameter 'imageIndex' when calling getUserImageByIndex(Async)"); + throw new ApiException("Missing the required parameter 'imageIndex' when calling headArtistImage(Async)"); } - return getUserImageByIndexCall(userId, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + return headArtistImageCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); } /** - * Get user profile image. + * Get artist image by name. * - * @param userId User id. (required) + * @param name Artist name. (required) * @param imageType Image type. (required) * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) @@ -5017,8 +4618,6 @@ private okhttp3.Call getUserImageByIndexValidateBeforeCall(UUID userId, ImageTyp * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -5032,15 +4631,15 @@ private okhttp3.Call getUserImageByIndexValidateBeforeCall(UUID userId, ImageTyp 404 Item not found. - */ - public File getUserImageByIndex(UUID userId, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = getUserImageByIndexWithHttpInfo(userId, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer); + public File headArtistImage(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + ApiResponse localVarResp = headArtistImageWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); return localVarResp.getData(); } /** - * Get user profile image. + * Get artist image by name. * - * @param userId User id. (required) + * @param name Artist name. (required) * @param imageType Image type. (required) * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) @@ -5054,8 +4653,6 @@ public File getUserImageByIndex(UUID userId, ImageType imageType, Integer imageI * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -5069,16 +4666,16 @@ public File getUserImageByIndex(UUID userId, ImageType imageType, Integer imageI 404 Item not found. - */ - public ApiResponse getUserImageByIndexWithHttpInfo(UUID userId, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = getUserImageByIndexValidateBeforeCall(userId, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, null); + public ApiResponse headArtistImageWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + okhttp3.Call localVarCall = headArtistImageValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Get user profile image. (asynchronously) + * Get artist image by name. (asynchronously) * - * @param userId User id. (required) + * @param name Artist name. (required) * @param imageType Image type. (required) * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) @@ -5092,8 +4689,6 @@ public ApiResponse getUserImageByIndexWithHttpInfo(UUID userId, ImageType * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -5108,18 +4703,17 @@ public ApiResponse getUserImageByIndexWithHttpInfo(UUID userId, ImageType 404 Item not found. - */ - public okhttp3.Call getUserImageByIndexAsync(UUID userId, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headArtistImageAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getUserImageByIndexValidateBeforeCall(userId, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + okhttp3.Call localVarCall = headArtistImageValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for headArtistImage - * @param name Artist name. (required) + * Build call for headGenreImage + * @param name Genre name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -5131,11 +4725,10 @@ public okhttp3.Call getUserImageByIndexAsync(UUID userId, ImageType imageType, I * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -5147,7 +4740,7 @@ public okhttp3.Call getUserImageByIndexAsync(UUID userId, ImageType imageType, I 404 Item not found. - */ - public okhttp3.Call headArtistImageCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headGenreImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -5164,10 +4757,9 @@ public okhttp3.Call headArtistImageCall(String name, ImageType imageType, Intege Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Artists/{name}/Images/{imageType}/{imageIndex}" + String localVarPath = "/Genres/{name}/Images/{imageType}" .replace("{" + "name" + "}", localVarApiClient.escapeString(name.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) - .replace("{" + "imageIndex" + "}", localVarApiClient.escapeString(imageIndex.toString())); + .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -5219,14 +4811,6 @@ public okhttp3.Call headArtistImageCall(String name, ImageType imageType, Intege localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -5239,6 +4823,10 @@ public okhttp3.Call headArtistImageCall(String name, ImageType imageType, Intege localVarQueryParams.addAll(localVarApiClient.parameterToPair("foregroundLayer", foregroundLayer)); } + if (imageIndex != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("imageIndex", imageIndex)); + } + final String[] localVarAccepts = { "image/*", "application/json", @@ -5262,32 +4850,26 @@ public okhttp3.Call headArtistImageCall(String name, ImageType imageType, Intege } @SuppressWarnings("rawtypes") - private okhttp3.Call headArtistImageValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + private okhttp3.Call headGenreImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { - throw new ApiException("Missing the required parameter 'name' when calling headArtistImage(Async)"); + throw new ApiException("Missing the required parameter 'name' when calling headGenreImage(Async)"); } // verify the required parameter 'imageType' is set if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling headArtistImage(Async)"); - } - - // verify the required parameter 'imageIndex' is set - if (imageIndex == null) { - throw new ApiException("Missing the required parameter 'imageIndex' when calling headArtistImage(Async)"); + throw new ApiException("Missing the required parameter 'imageType' when calling headGenreImage(Async)"); } - return headArtistImageCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + return headGenreImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); } /** - * Get artist image by name. + * Get genre image by name. * - * @param name Artist name. (required) + * @param name Genre name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -5299,11 +4881,10 @@ private okhttp3.Call headArtistImageValidateBeforeCall(String name, ImageType im * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -5314,17 +4895,16 @@ private okhttp3.Call headArtistImageValidateBeforeCall(String name, ImageType im 404 Item not found. - */ - public File headArtistImage(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = headArtistImageWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer); + public File headGenreImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + ApiResponse localVarResp = headGenreImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); return localVarResp.getData(); } /** - * Get artist image by name. + * Get genre image by name. * - * @param name Artist name. (required) + * @param name Genre name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -5336,11 +4916,10 @@ public File headArtistImage(String name, ImageType imageType, Integer imageIndex * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -5351,18 +4930,17 @@ public File headArtistImage(String name, ImageType imageType, Integer imageIndex 404 Item not found. - */ - public ApiResponse headArtistImageWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = headArtistImageValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, null); + public ApiResponse headGenreImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + okhttp3.Call localVarCall = headGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Get artist image by name. (asynchronously) + * Get genre image by name. (asynchronously) * - * @param name Artist name. (required) + * @param name Genre name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -5374,11 +4952,10 @@ public ApiResponse headArtistImageWithHttpInfo(String name, ImageType imag * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -5390,17 +4967,18 @@ public ApiResponse headArtistImageWithHttpInfo(String name, ImageType imag 404 Item not found. - */ - public okhttp3.Call headArtistImageAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headGenreImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headArtistImageValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + okhttp3.Call localVarCall = headGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for headGenreImage + * Build call for headGenreImageByIndex * @param name Genre name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -5412,12 +4990,9 @@ public okhttp3.Call headArtistImageAsync(String name, ImageType imageType, Integ * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -5429,7 +5004,7 @@ public okhttp3.Call headArtistImageAsync(String name, ImageType imageType, Integ 404 Item not found. - */ - public okhttp3.Call headGenreImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headGenreImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -5446,9 +5021,10 @@ public okhttp3.Call headGenreImageCall(String name, ImageType imageType, String Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Genres/{name}/Images/{imageType}" + String localVarPath = "/Genres/{name}/Images/{imageType}/{imageIndex}" .replace("{" + "name" + "}", localVarApiClient.escapeString(name.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())); + .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) + .replace("{" + "imageIndex" + "}", localVarApiClient.escapeString(imageIndex.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -5500,14 +5076,6 @@ public okhttp3.Call headGenreImageCall(String name, ImageType imageType, String localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -5520,10 +5088,6 @@ public okhttp3.Call headGenreImageCall(String name, ImageType imageType, String localVarQueryParams.addAll(localVarApiClient.parameterToPair("foregroundLayer", foregroundLayer)); } - if (imageIndex != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("imageIndex", imageIndex)); - } - final String[] localVarAccepts = { "image/*", "application/json", @@ -5547,18 +5111,23 @@ public okhttp3.Call headGenreImageCall(String name, ImageType imageType, String } @SuppressWarnings("rawtypes") - private okhttp3.Call headGenreImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + private okhttp3.Call headGenreImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { - throw new ApiException("Missing the required parameter 'name' when calling headGenreImage(Async)"); + throw new ApiException("Missing the required parameter 'name' when calling headGenreImageByIndex(Async)"); } // verify the required parameter 'imageType' is set if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling headGenreImage(Async)"); + throw new ApiException("Missing the required parameter 'imageType' when calling headGenreImageByIndex(Async)"); + } + + // verify the required parameter 'imageIndex' is set + if (imageIndex == null) { + throw new ApiException("Missing the required parameter 'imageIndex' when calling headGenreImageByIndex(Async)"); } - return headGenreImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + return headGenreImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); } @@ -5567,6 +5136,7 @@ private okhttp3.Call headGenreImageValidateBeforeCall(String name, ImageType ima * * @param name Genre name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -5578,12 +5148,9 @@ private okhttp3.Call headGenreImageValidateBeforeCall(String name, ImageType ima * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -5594,8 +5161,8 @@ private okhttp3.Call headGenreImageValidateBeforeCall(String name, ImageType ima 404 Item not found. - */ - public File headGenreImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - ApiResponse localVarResp = headGenreImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex); + public File headGenreImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + ApiResponse localVarResp = headGenreImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); return localVarResp.getData(); } @@ -5604,6 +5171,7 @@ public File headGenreImage(String name, ImageType imageType, String tag, ImageFo * * @param name Genre name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -5615,12 +5183,9 @@ public File headGenreImage(String name, ImageType imageType, String tag, ImageFo * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -5631,8 +5196,8 @@ public File headGenreImage(String name, ImageType imageType, String tag, ImageFo 404 Item not found. - */ - public ApiResponse headGenreImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - okhttp3.Call localVarCall = headGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, null); + public ApiResponse headGenreImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + okhttp3.Call localVarCall = headGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -5642,6 +5207,7 @@ public ApiResponse headGenreImageWithHttpInfo(String name, ImageType image * * @param name Genre name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -5653,12 +5219,9 @@ public ApiResponse headGenreImageWithHttpInfo(String name, ImageType image * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -5670,34 +5233,32 @@ public ApiResponse headGenreImageWithHttpInfo(String name, ImageType image 404 Item not found. - */ - public okhttp3.Call headGenreImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headGenreImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + okhttp3.Call localVarCall = headGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for headGenreImageByIndex - * @param name Genre name. (required) + * Build call for headItemImage + * @param itemId Item id. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) * @param maxHeight The maximum image height to return. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param width The fixed image width to return. (optional) * @param height The fixed image height to return. (optional) * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) + * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) + * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) + * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) + * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -5709,7 +5270,7 @@ public okhttp3.Call headGenreImageAsync(String name, ImageType imageType, String 404 Item not found. - */ - public okhttp3.Call headGenreImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headItemImageCall(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -5726,10 +5287,9 @@ public okhttp3.Call headGenreImageByIndexCall(String name, ImageType imageType, Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Genres/{name}/Images/{imageType}/{imageIndex}" - .replace("{" + "name" + "}", localVarApiClient.escapeString(name.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) - .replace("{" + "imageIndex" + "}", localVarApiClient.escapeString(imageIndex.toString())); + String localVarPath = "/Items/{itemId}/Images/{imageType}" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())) + .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -5737,14 +5297,6 @@ public okhttp3.Call headGenreImageByIndexCall(String name, ImageType imageType, Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); - if (tag != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("tag", tag)); - } - - if (format != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("format", format)); - } - if (maxWidth != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxWidth", maxWidth)); } @@ -5753,14 +5305,6 @@ public okhttp3.Call headGenreImageByIndexCall(String name, ImageType imageType, localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxHeight", maxHeight)); } - if (percentPlayed != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("percentPlayed", percentPlayed)); - } - - if (unplayedCount != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("unplayedCount", unplayedCount)); - } - if (width != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("width", width)); } @@ -5781,12 +5325,20 @@ public okhttp3.Call headGenreImageByIndexCall(String name, ImageType imageType, localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); + if (tag != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("tag", tag)); + } + + if (format != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("format", format)); + } + + if (percentPlayed != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("percentPlayed", percentPlayed)); } - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); + if (unplayedCount != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("unplayedCount", unplayedCount)); } if (blur != null) { @@ -5801,6 +5353,10 @@ public okhttp3.Call headGenreImageByIndexCall(String name, ImageType imageType, localVarQueryParams.addAll(localVarApiClient.parameterToPair("foregroundLayer", foregroundLayer)); } + if (imageIndex != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("imageIndex", imageIndex)); + } + final String[] localVarAccepts = { "image/*", "application/json", @@ -5824,48 +5380,41 @@ public okhttp3.Call headGenreImageByIndexCall(String name, ImageType imageType, } @SuppressWarnings("rawtypes") - private okhttp3.Call headGenreImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'name' is set - if (name == null) { - throw new ApiException("Missing the required parameter 'name' when calling headGenreImageByIndex(Async)"); + private okhttp3.Call headItemImageValidateBeforeCall(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling headItemImage(Async)"); } // verify the required parameter 'imageType' is set if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling headGenreImageByIndex(Async)"); - } - - // verify the required parameter 'imageIndex' is set - if (imageIndex == null) { - throw new ApiException("Missing the required parameter 'imageIndex' when calling headGenreImageByIndex(Async)"); + throw new ApiException("Missing the required parameter 'imageType' when calling headItemImage(Async)"); } - return headGenreImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + return headItemImageCall(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, _callback); } /** - * Get genre image by name. + * Gets the item's image. * - * @param name Genre name. (required) + * @param itemId Item id. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) * @param maxHeight The maximum image height to return. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param width The fixed image width to return. (optional) * @param height The fixed image height to return. (optional) * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) + * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) + * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) + * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) + * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -5876,33 +5425,31 @@ private okhttp3.Call headGenreImageByIndexValidateBeforeCall(String name, ImageT 404 Item not found. - */ - public File headGenreImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = headGenreImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer); + public File headItemImage(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + ApiResponse localVarResp = headItemImageWithHttpInfo(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex); return localVarResp.getData(); } /** - * Get genre image by name. + * Gets the item's image. * - * @param name Genre name. (required) + * @param itemId Item id. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) * @param maxHeight The maximum image height to return. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param width The fixed image width to return. (optional) * @param height The fixed image height to return. (optional) * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) + * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) + * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) + * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) + * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -5913,34 +5460,32 @@ public File headGenreImageByIndex(String name, ImageType imageType, Integer imag 404 Item not found. - */ - public ApiResponse headGenreImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = headGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, null); + public ApiResponse headItemImageWithHttpInfo(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + okhttp3.Call localVarCall = headItemImageValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Get genre image by name. (asynchronously) + * Gets the item's image. (asynchronously) * - * @param name Genre name. (required) + * @param itemId Item id. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) * @param maxHeight The maximum image height to return. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param width The fixed image width to return. (optional) * @param height The fixed image height to return. (optional) * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) + * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) + * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) + * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) + * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -5952,34 +5497,32 @@ public ApiResponse headGenreImageByIndexWithHttpInfo(String name, ImageTyp 404 Item not found. - */ - public okhttp3.Call headGenreImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headItemImageAsync(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + okhttp3.Call localVarCall = headItemImageValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for headItemImage + * Build call for headItemImage2 * @param itemId Item id. (required) * @param imageType Image type. (required) - * @param maxWidth The maximum image width to return. (optional) - * @param maxHeight The maximum image height to return. (optional) + * @param maxWidth The maximum image width to return. (required) + * @param maxHeight The maximum image height to return. (required) + * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (required) + * @param format Determines the output format of the image - original,gif,jpg,png. (required) + * @param percentPlayed Optional. Percent to render for the percent played overlay. (required) + * @param unplayedCount Optional. Unplayed count overlay to render. (required) + * @param imageIndex Image index. (required) * @param width The fixed image width to return. (optional) * @param height The fixed image height to return. (optional) * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -5991,7 +5534,7 @@ public okhttp3.Call headGenreImageByIndexAsync(String name, ImageType imageType, 404 Item not found. - */ - public okhttp3.Call headItemImageCall(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headItemImage2Call(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -6008,9 +5551,16 @@ public okhttp3.Call headItemImageCall(UUID itemId, ImageType imageType, Integer Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Items/{itemId}/Images/{imageType}" + String localVarPath = "/Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount}" .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())); + .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) + .replace("{" + "maxWidth" + "}", localVarApiClient.escapeString(maxWidth.toString())) + .replace("{" + "maxHeight" + "}", localVarApiClient.escapeString(maxHeight.toString())) + .replace("{" + "tag" + "}", localVarApiClient.escapeString(tag.toString())) + .replace("{" + "format" + "}", localVarApiClient.escapeString(format.toString())) + .replace("{" + "percentPlayed" + "}", localVarApiClient.escapeString(percentPlayed.toString())) + .replace("{" + "unplayedCount" + "}", localVarApiClient.escapeString(unplayedCount.toString())) + .replace("{" + "imageIndex" + "}", localVarApiClient.escapeString(imageIndex.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -6018,14 +5568,6 @@ public okhttp3.Call headItemImageCall(UUID itemId, ImageType imageType, Integer Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); - if (maxWidth != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxWidth", maxWidth)); - } - - if (maxHeight != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxHeight", maxHeight)); - } - if (width != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("width", width)); } @@ -6046,30 +5588,6 @@ public okhttp3.Call headItemImageCall(UUID itemId, ImageType imageType, Integer localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (tag != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("tag", tag)); - } - - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (format != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("format", format)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - - if (percentPlayed != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("percentPlayed", percentPlayed)); - } - - if (unplayedCount != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("unplayedCount", unplayedCount)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -6082,10 +5600,6 @@ public okhttp3.Call headItemImageCall(UUID itemId, ImageType imageType, Integer localVarQueryParams.addAll(localVarApiClient.parameterToPair("foregroundLayer", foregroundLayer)); } - if (imageIndex != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("imageIndex", imageIndex)); - } - final String[] localVarAccepts = { "image/*", "application/json", @@ -6109,18 +5623,53 @@ public okhttp3.Call headItemImageCall(UUID itemId, ImageType imageType, Integer } @SuppressWarnings("rawtypes") - private okhttp3.Call headItemImageValidateBeforeCall(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + private okhttp3.Call headItemImage2ValidateBeforeCall(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { - throw new ApiException("Missing the required parameter 'itemId' when calling headItemImage(Async)"); + throw new ApiException("Missing the required parameter 'itemId' when calling headItemImage2(Async)"); } // verify the required parameter 'imageType' is set if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling headItemImage(Async)"); + throw new ApiException("Missing the required parameter 'imageType' when calling headItemImage2(Async)"); + } + + // verify the required parameter 'maxWidth' is set + if (maxWidth == null) { + throw new ApiException("Missing the required parameter 'maxWidth' when calling headItemImage2(Async)"); + } + + // verify the required parameter 'maxHeight' is set + if (maxHeight == null) { + throw new ApiException("Missing the required parameter 'maxHeight' when calling headItemImage2(Async)"); + } + + // verify the required parameter 'tag' is set + if (tag == null) { + throw new ApiException("Missing the required parameter 'tag' when calling headItemImage2(Async)"); + } + + // verify the required parameter 'format' is set + if (format == null) { + throw new ApiException("Missing the required parameter 'format' when calling headItemImage2(Async)"); + } + + // verify the required parameter 'percentPlayed' is set + if (percentPlayed == null) { + throw new ApiException("Missing the required parameter 'percentPlayed' when calling headItemImage2(Async)"); + } + + // verify the required parameter 'unplayedCount' is set + if (unplayedCount == null) { + throw new ApiException("Missing the required parameter 'unplayedCount' when calling headItemImage2(Async)"); } - return headItemImageCall(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + // verify the required parameter 'imageIndex' is set + if (imageIndex == null) { + throw new ApiException("Missing the required parameter 'imageIndex' when calling headItemImage2(Async)"); + } + + return headItemImage2Call(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); } @@ -6129,23 +5678,21 @@ private okhttp3.Call headItemImageValidateBeforeCall(UUID itemId, ImageType imag * * @param itemId Item id. (required) * @param imageType Image type. (required) - * @param maxWidth The maximum image width to return. (optional) - * @param maxHeight The maximum image height to return. (optional) + * @param maxWidth The maximum image width to return. (required) + * @param maxHeight The maximum image height to return. (required) + * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (required) + * @param format Determines the output format of the image - original,gif,jpg,png. (required) + * @param percentPlayed Optional. Percent to render for the percent played overlay. (required) + * @param unplayedCount Optional. Unplayed count overlay to render. (required) + * @param imageIndex Image index. (required) * @param width The fixed image width to return. (optional) * @param height The fixed image height to return. (optional) * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -6156,268 +5703,11 @@ private okhttp3.Call headItemImageValidateBeforeCall(UUID itemId, ImageType imag 404 Item not found. - */ - public File headItemImage(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - ApiResponse localVarResp = headItemImageWithHttpInfo(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex); + public File headItemImage2(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + ApiResponse localVarResp = headItemImage2WithHttpInfo(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); return localVarResp.getData(); } - /** - * Gets the item's image. - * - * @param itemId Item id. (required) - * @param imageType Image type. (required) - * @param maxWidth The maximum image width to return. (optional) - * @param maxHeight The maximum image height to return. (optional) - * @param width The fixed image width to return. (optional) - * @param height The fixed image height to return. (optional) - * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) - * @param fillWidth Width of box to fill. (optional) - * @param fillHeight Height of box to fill. (optional) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) - * @param blur Optional. Blur image. (optional) - * @param backgroundColor Optional. Apply a background color for transparent images. (optional) - * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) - * @return ApiResponse<File> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - -
Response Details
Status Code Description Response Headers
200 Image stream returned. -
404 Item not found. -
- */ - public ApiResponse headItemImageWithHttpInfo(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - okhttp3.Call localVarCall = headItemImageValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Gets the item's image. (asynchronously) - * - * @param itemId Item id. (required) - * @param imageType Image type. (required) - * @param maxWidth The maximum image width to return. (optional) - * @param maxHeight The maximum image height to return. (optional) - * @param width The fixed image width to return. (optional) - * @param height The fixed image height to return. (optional) - * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) - * @param fillWidth Width of box to fill. (optional) - * @param fillHeight Height of box to fill. (optional) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) - * @param blur Optional. Blur image. (optional) - * @param backgroundColor Optional. Apply a background color for transparent images. (optional) - * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - - -
Response Details
Status Code Description Response Headers
200 Image stream returned. -
404 Item not found. -
- */ - public okhttp3.Call headItemImageAsync(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = headItemImageValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - /** - * Build call for headItemImage2 - * @param itemId Item id. (required) - * @param imageType Image type. (required) - * @param maxWidth The maximum image width to return. (required) - * @param maxHeight The maximum image height to return. (required) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (required) - * @param format Determines the output format of the image - original,gif,jpg,png. (required) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (required) - * @param unplayedCount Optional. Unplayed count overlay to render. (required) - * @param imageIndex Image index. (required) - * @param width The fixed image width to return. (optional) - * @param height The fixed image height to return. (optional) - * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) - * @param fillWidth Width of box to fill. (optional) - * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) - * @param blur Optional. Blur image. (optional) - * @param backgroundColor Optional. Apply a background color for transparent images. (optional) - * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - - -
Response Details
Status Code Description Response Headers
200 Image stream returned. -
404 Item not found. -
- */ - public okhttp3.Call headItemImage2Call(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - String basePath = null; - // Operation Servers - String[] localBasePaths = new String[] { }; - - // Determine Base Path to Use - if (localCustomBaseUrl != null){ - basePath = localCustomBaseUrl; - } else if ( localBasePaths.length > 0 ) { - basePath = localBasePaths[localHostIndex]; - } else { - basePath = null; - } - - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount}" - .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) - .replace("{" + "maxWidth" + "}", localVarApiClient.escapeString(maxWidth.toString())) - .replace("{" + "maxHeight" + "}", localVarApiClient.escapeString(maxHeight.toString())) - .replace("{" + "tag" + "}", localVarApiClient.escapeString(tag.toString())) - .replace("{" + "format" + "}", localVarApiClient.escapeString(format.toString())) - .replace("{" + "percentPlayed" + "}", localVarApiClient.escapeString(percentPlayed.toString())) - .replace("{" + "unplayedCount" + "}", localVarApiClient.escapeString(unplayedCount.toString())) - .replace("{" + "imageIndex" + "}", localVarApiClient.escapeString(imageIndex.toString())); - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - - if (width != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("width", width)); - } - - if (height != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("height", height)); - } - - if (quality != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("quality", quality)); - } - - if (fillWidth != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillWidth", fillWidth)); - } - - if (fillHeight != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); - } - - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - - if (blur != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); - } - - if (backgroundColor != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("backgroundColor", backgroundColor)); - } - - if (foregroundLayer != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("foregroundLayer", foregroundLayer)); - } - - final String[] localVarAccepts = { - "image/*", - "application/json", - "application/json; profile=CamelCase", - "application/json; profile=PascalCase" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - if (localVarContentType != null) { - localVarHeaderParams.put("Content-Type", localVarContentType); - } - - String[] localVarAuthNames = new String[] { }; - return localVarApiClient.buildCall(basePath, localVarPath, "HEAD", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call headItemImage2ValidateBeforeCall(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'itemId' is set - if (itemId == null) { - throw new ApiException("Missing the required parameter 'itemId' when calling headItemImage2(Async)"); - } - - // verify the required parameter 'imageType' is set - if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling headItemImage2(Async)"); - } - - // verify the required parameter 'maxWidth' is set - if (maxWidth == null) { - throw new ApiException("Missing the required parameter 'maxWidth' when calling headItemImage2(Async)"); - } - - // verify the required parameter 'maxHeight' is set - if (maxHeight == null) { - throw new ApiException("Missing the required parameter 'maxHeight' when calling headItemImage2(Async)"); - } - - // verify the required parameter 'tag' is set - if (tag == null) { - throw new ApiException("Missing the required parameter 'tag' when calling headItemImage2(Async)"); - } - - // verify the required parameter 'format' is set - if (format == null) { - throw new ApiException("Missing the required parameter 'format' when calling headItemImage2(Async)"); - } - - // verify the required parameter 'percentPlayed' is set - if (percentPlayed == null) { - throw new ApiException("Missing the required parameter 'percentPlayed' when calling headItemImage2(Async)"); - } - - // verify the required parameter 'unplayedCount' is set - if (unplayedCount == null) { - throw new ApiException("Missing the required parameter 'unplayedCount' when calling headItemImage2(Async)"); - } - - // verify the required parameter 'imageIndex' is set - if (imageIndex == null) { - throw new ApiException("Missing the required parameter 'imageIndex' when calling headItemImage2(Async)"); - } - - return headItemImage2Call(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); - - } - /** * Gets the item's image. * @@ -6435,12 +5725,10 @@ private okhttp3.Call headItemImage2ValidateBeforeCall(UUID itemId, ImageType ima * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @return File + * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -6450,13 +5738,14 @@ private okhttp3.Call headItemImage2ValidateBeforeCall(UUID itemId, ImageType ima
404 Item not found. -
*/ - public File headItemImage2(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = headItemImage2WithHttpInfo(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer); - return localVarResp.getData(); + public ApiResponse headItemImage2WithHttpInfo(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + okhttp3.Call localVarCall = headItemImage2ValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Gets the item's image. + * Gets the item's image. (asynchronously) * * @param itemId Item id. (required) * @param imageType Image type. (required) @@ -6470,330 +5759,8 @@ public File headItemImage2(UUID itemId, ImageType imageType, Integer maxWidth, I * @param width The fixed image width to return. (optional) * @param height The fixed image height to return. (optional) * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) - * @param fillWidth Width of box to fill. (optional) - * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) - * @param blur Optional. Blur image. (optional) - * @param backgroundColor Optional. Apply a background color for transparent images. (optional) - * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @return ApiResponse<File> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - -
Response Details
Status Code Description Response Headers
200 Image stream returned. -
404 Item not found. -
- */ - public ApiResponse headItemImage2WithHttpInfo(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = headItemImage2ValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Gets the item's image. (asynchronously) - * - * @param itemId Item id. (required) - * @param imageType Image type. (required) - * @param maxWidth The maximum image width to return. (required) - * @param maxHeight The maximum image height to return. (required) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (required) - * @param format Determines the output format of the image - original,gif,jpg,png. (required) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (required) - * @param unplayedCount Optional. Unplayed count overlay to render. (required) - * @param imageIndex Image index. (required) - * @param width The fixed image width to return. (optional) - * @param height The fixed image height to return. (optional) - * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) - * @param fillWidth Width of box to fill. (optional) - * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) - * @param blur Optional. Blur image. (optional) - * @param backgroundColor Optional. Apply a background color for transparent images. (optional) - * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - - -
Response Details
Status Code Description Response Headers
200 Image stream returned. -
404 Item not found. -
- */ - public okhttp3.Call headItemImage2Async(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = headItemImage2ValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - /** - * Build call for headItemImageByIndex - * @param itemId Item id. (required) - * @param imageType Image type. (required) - * @param imageIndex Image index. (required) - * @param maxWidth The maximum image width to return. (optional) - * @param maxHeight The maximum image height to return. (optional) - * @param width The fixed image width to return. (optional) - * @param height The fixed image height to return. (optional) - * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) - * @param fillWidth Width of box to fill. (optional) - * @param fillHeight Height of box to fill. (optional) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) - * @param blur Optional. Blur image. (optional) - * @param backgroundColor Optional. Apply a background color for transparent images. (optional) - * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - - -
Response Details
Status Code Description Response Headers
200 Image stream returned. -
404 Item not found. -
- */ - public okhttp3.Call headItemImageByIndexCall(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - String basePath = null; - // Operation Servers - String[] localBasePaths = new String[] { }; - - // Determine Base Path to Use - if (localCustomBaseUrl != null){ - basePath = localCustomBaseUrl; - } else if ( localBasePaths.length > 0 ) { - basePath = localBasePaths[localHostIndex]; - } else { - basePath = null; - } - - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/Items/{itemId}/Images/{imageType}/{imageIndex}" - .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) - .replace("{" + "imageIndex" + "}", localVarApiClient.escapeString(imageIndex.toString())); - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - - if (maxWidth != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxWidth", maxWidth)); - } - - if (maxHeight != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxHeight", maxHeight)); - } - - if (width != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("width", width)); - } - - if (height != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("height", height)); - } - - if (quality != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("quality", quality)); - } - - if (fillWidth != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillWidth", fillWidth)); - } - - if (fillHeight != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); - } - - if (tag != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("tag", tag)); - } - - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (format != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("format", format)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - - if (percentPlayed != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("percentPlayed", percentPlayed)); - } - - if (unplayedCount != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("unplayedCount", unplayedCount)); - } - - if (blur != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); - } - - if (backgroundColor != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("backgroundColor", backgroundColor)); - } - - if (foregroundLayer != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("foregroundLayer", foregroundLayer)); - } - - final String[] localVarAccepts = { - "image/*", - "application/json", - "application/json; profile=CamelCase", - "application/json; profile=PascalCase" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - if (localVarContentType != null) { - localVarHeaderParams.put("Content-Type", localVarContentType); - } - - String[] localVarAuthNames = new String[] { }; - return localVarApiClient.buildCall(basePath, localVarPath, "HEAD", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call headItemImageByIndexValidateBeforeCall(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'itemId' is set - if (itemId == null) { - throw new ApiException("Missing the required parameter 'itemId' when calling headItemImageByIndex(Async)"); - } - - // verify the required parameter 'imageType' is set - if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling headItemImageByIndex(Async)"); - } - - // verify the required parameter 'imageIndex' is set - if (imageIndex == null) { - throw new ApiException("Missing the required parameter 'imageIndex' when calling headItemImageByIndex(Async)"); - } - - return headItemImageByIndexCall(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, _callback); - - } - - /** - * Gets the item's image. - * - * @param itemId Item id. (required) - * @param imageType Image type. (required) - * @param imageIndex Image index. (required) - * @param maxWidth The maximum image width to return. (optional) - * @param maxHeight The maximum image height to return. (optional) - * @param width The fixed image width to return. (optional) - * @param height The fixed image height to return. (optional) - * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) - * @param fillWidth Width of box to fill. (optional) - * @param fillHeight Height of box to fill. (optional) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) - * @param blur Optional. Blur image. (optional) - * @param backgroundColor Optional. Apply a background color for transparent images. (optional) - * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @return File - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - -
Response Details
Status Code Description Response Headers
200 Image stream returned. -
404 Item not found. -
- */ - public File headItemImageByIndex(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = headItemImageByIndexWithHttpInfo(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer); - return localVarResp.getData(); - } - - /** - * Gets the item's image. - * - * @param itemId Item id. (required) - * @param imageType Image type. (required) - * @param imageIndex Image index. (required) - * @param maxWidth The maximum image width to return. (optional) - * @param maxHeight The maximum image height to return. (optional) - * @param width The fixed image width to return. (optional) - * @param height The fixed image height to return. (optional) - * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) - * @param fillWidth Width of box to fill. (optional) - * @param fillHeight Height of box to fill. (optional) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) - * @param blur Optional. Blur image. (optional) - * @param backgroundColor Optional. Apply a background color for transparent images. (optional) - * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @return ApiResponse<File> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - -
Response Details
Status Code Description Response Headers
200 Image stream returned. -
404 Item not found. -
- */ - public ApiResponse headItemImageByIndexWithHttpInfo(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = headItemImageByIndexValidateBeforeCall(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Gets the item's image. (asynchronously) - * - * @param itemId Item id. (required) - * @param imageType Image type. (required) - * @param imageIndex Image index. (required) - * @param maxWidth The maximum image width to return. (optional) - * @param maxHeight The maximum image height to return. (optional) - * @param width The fixed image width to return. (optional) - * @param height The fixed image height to return. (optional) - * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) - * @param fillWidth Width of box to fill. (optional) - * @param fillHeight Height of box to fill. (optional) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) + * @param fillWidth Width of box to fill. (optional) + * @param fillHeight Height of box to fill. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) @@ -6808,34 +5775,32 @@ public ApiResponse headItemImageByIndexWithHttpInfo(UUID itemId, ImageType 404 Item not found. - */ - public okhttp3.Call headItemImageByIndexAsync(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, Boolean cropWhitespace, ImageFormat format, Boolean addPlayedIndicator, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headItemImage2Async(UUID itemId, ImageType imageType, Integer maxWidth, Integer maxHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer imageIndex, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headItemImageByIndexValidateBeforeCall(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, _callback); + okhttp3.Call localVarCall = headItemImage2ValidateBeforeCall(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for headMusicGenreImage - * @param name Music genre name. (required) + * Build call for headItemImageByIndex + * @param itemId Item id. (required) * @param imageType Image type. (required) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param format Determines the output format of the image - original,gif,jpg,png. (optional) + * @param imageIndex Image index. (required) * @param maxWidth The maximum image width to return. (optional) * @param maxHeight The maximum image height to return. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param width The fixed image width to return. (optional) * @param height The fixed image height to return. (optional) * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) + * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) + * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) + * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) + * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -6847,7 +5812,7 @@ public okhttp3.Call headItemImageByIndexAsync(UUID itemId, ImageType imageType, 404 Item not found. - */ - public okhttp3.Call headMusicGenreImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headItemImageByIndexCall(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -6864,9 +5829,10 @@ public okhttp3.Call headMusicGenreImageCall(String name, ImageType imageType, St Object localVarPostBody = null; // create path and map variables - String localVarPath = "/MusicGenres/{name}/Images/{imageType}" - .replace("{" + "name" + "}", localVarApiClient.escapeString(name.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())); + String localVarPath = "/Items/{itemId}/Images/{imageType}/{imageIndex}" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())) + .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) + .replace("{" + "imageIndex" + "}", localVarApiClient.escapeString(imageIndex.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -6874,14 +5840,6 @@ public okhttp3.Call headMusicGenreImageCall(String name, ImageType imageType, St Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); - if (tag != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("tag", tag)); - } - - if (format != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("format", format)); - } - if (maxWidth != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxWidth", maxWidth)); } @@ -6890,14 +5848,6 @@ public okhttp3.Call headMusicGenreImageCall(String name, ImageType imageType, St localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxHeight", maxHeight)); } - if (percentPlayed != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("percentPlayed", percentPlayed)); - } - - if (unplayedCount != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("unplayedCount", unplayedCount)); - } - if (width != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("width", width)); } @@ -6918,12 +5868,20 @@ public okhttp3.Call headMusicGenreImageCall(String name, ImageType imageType, St localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); + if (tag != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("tag", tag)); + } + + if (format != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("format", format)); + } + + if (percentPlayed != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("percentPlayed", percentPlayed)); } - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); + if (unplayedCount != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("unplayedCount", unplayedCount)); } if (blur != null) { @@ -6938,10 +5896,6 @@ public okhttp3.Call headMusicGenreImageCall(String name, ImageType imageType, St localVarQueryParams.addAll(localVarApiClient.parameterToPair("foregroundLayer", foregroundLayer)); } - if (imageIndex != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("imageIndex", imageIndex)); - } - final String[] localVarAccepts = { "image/*", "application/json", @@ -6965,43 +5919,46 @@ public okhttp3.Call headMusicGenreImageCall(String name, ImageType imageType, St } @SuppressWarnings("rawtypes") - private okhttp3.Call headMusicGenreImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'name' is set - if (name == null) { - throw new ApiException("Missing the required parameter 'name' when calling headMusicGenreImage(Async)"); + private okhttp3.Call headItemImageByIndexValidateBeforeCall(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling headItemImageByIndex(Async)"); } // verify the required parameter 'imageType' is set if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling headMusicGenreImage(Async)"); + throw new ApiException("Missing the required parameter 'imageType' when calling headItemImageByIndex(Async)"); + } + + // verify the required parameter 'imageIndex' is set + if (imageIndex == null) { + throw new ApiException("Missing the required parameter 'imageIndex' when calling headItemImageByIndex(Async)"); } - return headMusicGenreImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + return headItemImageByIndexCall(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, _callback); } /** - * Get music genre image by name. + * Gets the item's image. * - * @param name Music genre name. (required) + * @param itemId Item id. (required) * @param imageType Image type. (required) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param format Determines the output format of the image - original,gif,jpg,png. (optional) + * @param imageIndex Image index. (required) * @param maxWidth The maximum image width to return. (optional) * @param maxHeight The maximum image height to return. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param width The fixed image width to return. (optional) * @param height The fixed image height to return. (optional) * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) + * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) + * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) + * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) + * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -7012,33 +5969,31 @@ private okhttp3.Call headMusicGenreImageValidateBeforeCall(String name, ImageTyp 404 Item not found. - */ - public File headMusicGenreImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - ApiResponse localVarResp = headMusicGenreImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex); + public File headItemImageByIndex(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + ApiResponse localVarResp = headItemImageByIndexWithHttpInfo(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer); return localVarResp.getData(); } /** - * Get music genre image by name. + * Gets the item's image. * - * @param name Music genre name. (required) + * @param itemId Item id. (required) * @param imageType Image type. (required) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param format Determines the output format of the image - original,gif,jpg,png. (optional) + * @param imageIndex Image index. (required) * @param maxWidth The maximum image width to return. (optional) * @param maxHeight The maximum image height to return. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param width The fixed image width to return. (optional) * @param height The fixed image height to return. (optional) * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) + * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) + * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) + * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) + * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -7049,34 +6004,32 @@ public File headMusicGenreImage(String name, ImageType imageType, String tag, Im 404 Item not found. - */ - public ApiResponse headMusicGenreImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - okhttp3.Call localVarCall = headMusicGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, null); + public ApiResponse headItemImageByIndexWithHttpInfo(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + okhttp3.Call localVarCall = headItemImageByIndexValidateBeforeCall(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Get music genre image by name. (asynchronously) + * Gets the item's image. (asynchronously) * - * @param name Music genre name. (required) + * @param itemId Item id. (required) * @param imageType Image type. (required) - * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) - * @param format Determines the output format of the image - original,gif,jpg,png. (optional) + * @param imageIndex Image index. (required) * @param maxWidth The maximum image width to return. (optional) * @param maxHeight The maximum image height to return. (optional) - * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) - * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param width The fixed image width to return. (optional) * @param height The fixed image height to return. (optional) * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) + * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) + * @param format Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. (optional) + * @param percentPlayed Optional. Percent to render for the percent played overlay. (optional) + * @param unplayedCount Optional. Unplayed count overlay to render. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -7088,18 +6041,17 @@ public ApiResponse headMusicGenreImageWithHttpInfo(String name, ImageType 404 Item not found. - */ - public okhttp3.Call headMusicGenreImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headItemImageByIndexAsync(UUID itemId, ImageType imageType, Integer imageIndex, Integer maxWidth, Integer maxHeight, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, String tag, ImageFormat format, Double percentPlayed, Integer unplayedCount, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headMusicGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + okhttp3.Call localVarCall = headItemImageByIndexValidateBeforeCall(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for headMusicGenreImageByIndex + * Build call for headMusicGenreImage * @param name Music genre name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -7111,11 +6063,10 @@ public okhttp3.Call headMusicGenreImageAsync(String name, ImageType imageType, S * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -7127,7 +6078,7 @@ public okhttp3.Call headMusicGenreImageAsync(String name, ImageType imageType, S 404 Item not found. - */ - public okhttp3.Call headMusicGenreImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headMusicGenreImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -7144,10 +6095,9 @@ public okhttp3.Call headMusicGenreImageByIndexCall(String name, ImageType imageT Object localVarPostBody = null; // create path and map variables - String localVarPath = "/MusicGenres/{name}/Images/{imageType}/{imageIndex}" + String localVarPath = "/MusicGenres/{name}/Images/{imageType}" .replace("{" + "name" + "}", localVarApiClient.escapeString(name.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) - .replace("{" + "imageIndex" + "}", localVarApiClient.escapeString(imageIndex.toString())); + .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -7199,14 +6149,6 @@ public okhttp3.Call headMusicGenreImageByIndexCall(String name, ImageType imageT localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -7219,6 +6161,10 @@ public okhttp3.Call headMusicGenreImageByIndexCall(String name, ImageType imageT localVarQueryParams.addAll(localVarApiClient.parameterToPair("foregroundLayer", foregroundLayer)); } + if (imageIndex != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("imageIndex", imageIndex)); + } + final String[] localVarAccepts = { "image/*", "application/json", @@ -7242,23 +6188,18 @@ public okhttp3.Call headMusicGenreImageByIndexCall(String name, ImageType imageT } @SuppressWarnings("rawtypes") - private okhttp3.Call headMusicGenreImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + private okhttp3.Call headMusicGenreImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { - throw new ApiException("Missing the required parameter 'name' when calling headMusicGenreImageByIndex(Async)"); + throw new ApiException("Missing the required parameter 'name' when calling headMusicGenreImage(Async)"); } // verify the required parameter 'imageType' is set if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling headMusicGenreImageByIndex(Async)"); - } - - // verify the required parameter 'imageIndex' is set - if (imageIndex == null) { - throw new ApiException("Missing the required parameter 'imageIndex' when calling headMusicGenreImageByIndex(Async)"); + throw new ApiException("Missing the required parameter 'imageType' when calling headMusicGenreImage(Async)"); } - return headMusicGenreImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + return headMusicGenreImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); } @@ -7267,7 +6208,6 @@ private okhttp3.Call headMusicGenreImageByIndexValidateBeforeCall(String name, I * * @param name Music genre name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -7279,11 +6219,10 @@ private okhttp3.Call headMusicGenreImageByIndexValidateBeforeCall(String name, I * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -7294,8 +6233,8 @@ private okhttp3.Call headMusicGenreImageByIndexValidateBeforeCall(String name, I 404 Item not found. - */ - public File headMusicGenreImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = headMusicGenreImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer); + public File headMusicGenreImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + ApiResponse localVarResp = headMusicGenreImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); return localVarResp.getData(); } @@ -7304,7 +6243,6 @@ public File headMusicGenreImageByIndex(String name, ImageType imageType, Integer * * @param name Music genre name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -7316,11 +6254,10 @@ public File headMusicGenreImageByIndex(String name, ImageType imageType, Integer * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -7331,8 +6268,8 @@ public File headMusicGenreImageByIndex(String name, ImageType imageType, Integer 404 Item not found. - */ - public ApiResponse headMusicGenreImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = headMusicGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, null); + public ApiResponse headMusicGenreImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + okhttp3.Call localVarCall = headMusicGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -7342,7 +6279,6 @@ public ApiResponse headMusicGenreImageByIndexWithHttpInfo(String name, Ima * * @param name Music genre name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -7354,11 +6290,10 @@ public ApiResponse headMusicGenreImageByIndexWithHttpInfo(String name, Ima * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -7370,17 +6305,18 @@ public ApiResponse headMusicGenreImageByIndexWithHttpInfo(String name, Ima 404 Item not found. - */ - public okhttp3.Call headMusicGenreImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headMusicGenreImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headMusicGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + okhttp3.Call localVarCall = headMusicGenreImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for headPersonImage - * @param name Person name. (required) + * Build call for headMusicGenreImageByIndex + * @param name Music genre name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -7392,12 +6328,9 @@ public okhttp3.Call headMusicGenreImageByIndexAsync(String name, ImageType image * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -7409,7 +6342,7 @@ public okhttp3.Call headMusicGenreImageByIndexAsync(String name, ImageType image 404 Item not found. - */ - public okhttp3.Call headPersonImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headMusicGenreImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -7426,9 +6359,10 @@ public okhttp3.Call headPersonImageCall(String name, ImageType imageType, String Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Persons/{name}/Images/{imageType}" + String localVarPath = "/MusicGenres/{name}/Images/{imageType}/{imageIndex}" .replace("{" + "name" + "}", localVarApiClient.escapeString(name.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())); + .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) + .replace("{" + "imageIndex" + "}", localVarApiClient.escapeString(imageIndex.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -7480,14 +6414,6 @@ public okhttp3.Call headPersonImageCall(String name, ImageType imageType, String localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -7500,10 +6426,6 @@ public okhttp3.Call headPersonImageCall(String name, ImageType imageType, String localVarQueryParams.addAll(localVarApiClient.parameterToPair("foregroundLayer", foregroundLayer)); } - if (imageIndex != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("imageIndex", imageIndex)); - } - final String[] localVarAccepts = { "image/*", "application/json", @@ -7527,26 +6449,32 @@ public okhttp3.Call headPersonImageCall(String name, ImageType imageType, String } @SuppressWarnings("rawtypes") - private okhttp3.Call headPersonImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + private okhttp3.Call headMusicGenreImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { - throw new ApiException("Missing the required parameter 'name' when calling headPersonImage(Async)"); + throw new ApiException("Missing the required parameter 'name' when calling headMusicGenreImageByIndex(Async)"); } // verify the required parameter 'imageType' is set if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling headPersonImage(Async)"); + throw new ApiException("Missing the required parameter 'imageType' when calling headMusicGenreImageByIndex(Async)"); + } + + // verify the required parameter 'imageIndex' is set + if (imageIndex == null) { + throw new ApiException("Missing the required parameter 'imageIndex' when calling headMusicGenreImageByIndex(Async)"); } - return headPersonImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + return headMusicGenreImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); } /** - * Get person image by name. + * Get music genre image by name. * - * @param name Person name. (required) + * @param name Music genre name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -7558,12 +6486,9 @@ private okhttp3.Call headPersonImageValidateBeforeCall(String name, ImageType im * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -7574,16 +6499,17 @@ private okhttp3.Call headPersonImageValidateBeforeCall(String name, ImageType im 404 Item not found. - */ - public File headPersonImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - ApiResponse localVarResp = headPersonImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex); + public File headMusicGenreImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + ApiResponse localVarResp = headMusicGenreImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); return localVarResp.getData(); } /** - * Get person image by name. + * Get music genre image by name. * - * @param name Person name. (required) + * @param name Music genre name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -7595,12 +6521,9 @@ public File headPersonImage(String name, ImageType imageType, String tag, ImageF * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -7611,17 +6534,18 @@ public File headPersonImage(String name, ImageType imageType, String tag, ImageF 404 Item not found. - */ - public ApiResponse headPersonImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - okhttp3.Call localVarCall = headPersonImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, null); + public ApiResponse headMusicGenreImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + okhttp3.Call localVarCall = headMusicGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Get person image by name. (asynchronously) + * Get music genre image by name. (asynchronously) * - * @param name Person name. (required) + * @param name Music genre name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -7633,12 +6557,9 @@ public ApiResponse headPersonImageWithHttpInfo(String name, ImageType imag * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -7650,18 +6571,17 @@ public ApiResponse headPersonImageWithHttpInfo(String name, ImageType imag 404 Item not found. - */ - public okhttp3.Call headPersonImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headMusicGenreImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headPersonImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + okhttp3.Call localVarCall = headMusicGenreImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for headPersonImageByIndex + * Build call for headPersonImage * @param name Person name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -7673,11 +6593,10 @@ public okhttp3.Call headPersonImageAsync(String name, ImageType imageType, Strin * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -7689,7 +6608,7 @@ public okhttp3.Call headPersonImageAsync(String name, ImageType imageType, Strin 404 Item not found. - */ - public okhttp3.Call headPersonImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headPersonImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -7706,10 +6625,9 @@ public okhttp3.Call headPersonImageByIndexCall(String name, ImageType imageType, Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Persons/{name}/Images/{imageType}/{imageIndex}" + String localVarPath = "/Persons/{name}/Images/{imageType}" .replace("{" + "name" + "}", localVarApiClient.escapeString(name.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) - .replace("{" + "imageIndex" + "}", localVarApiClient.escapeString(imageIndex.toString())); + .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -7761,14 +6679,6 @@ public okhttp3.Call headPersonImageByIndexCall(String name, ImageType imageType, localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -7781,6 +6691,10 @@ public okhttp3.Call headPersonImageByIndexCall(String name, ImageType imageType, localVarQueryParams.addAll(localVarApiClient.parameterToPair("foregroundLayer", foregroundLayer)); } + if (imageIndex != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("imageIndex", imageIndex)); + } + final String[] localVarAccepts = { "image/*", "application/json", @@ -7804,23 +6718,18 @@ public okhttp3.Call headPersonImageByIndexCall(String name, ImageType imageType, } @SuppressWarnings("rawtypes") - private okhttp3.Call headPersonImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + private okhttp3.Call headPersonImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { - throw new ApiException("Missing the required parameter 'name' when calling headPersonImageByIndex(Async)"); + throw new ApiException("Missing the required parameter 'name' when calling headPersonImage(Async)"); } // verify the required parameter 'imageType' is set if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling headPersonImageByIndex(Async)"); - } - - // verify the required parameter 'imageIndex' is set - if (imageIndex == null) { - throw new ApiException("Missing the required parameter 'imageIndex' when calling headPersonImageByIndex(Async)"); + throw new ApiException("Missing the required parameter 'imageType' when calling headPersonImage(Async)"); } - return headPersonImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + return headPersonImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); } @@ -7829,7 +6738,6 @@ private okhttp3.Call headPersonImageByIndexValidateBeforeCall(String name, Image * * @param name Person name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -7841,11 +6749,10 @@ private okhttp3.Call headPersonImageByIndexValidateBeforeCall(String name, Image * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -7856,8 +6763,8 @@ private okhttp3.Call headPersonImageByIndexValidateBeforeCall(String name, Image 404 Item not found. - */ - public File headPersonImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = headPersonImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer); + public File headPersonImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + ApiResponse localVarResp = headPersonImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); return localVarResp.getData(); } @@ -7866,7 +6773,6 @@ public File headPersonImageByIndex(String name, ImageType imageType, Integer ima * * @param name Person name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -7878,11 +6784,10 @@ public File headPersonImageByIndex(String name, ImageType imageType, Integer ima * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -7893,8 +6798,8 @@ public File headPersonImageByIndex(String name, ImageType imageType, Integer ima 404 Item not found. - */ - public ApiResponse headPersonImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = headPersonImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, null); + public ApiResponse headPersonImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + okhttp3.Call localVarCall = headPersonImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -7904,7 +6809,6 @@ public ApiResponse headPersonImageByIndexWithHttpInfo(String name, ImageTy * * @param name Person name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -7916,11 +6820,10 @@ public ApiResponse headPersonImageByIndexWithHttpInfo(String name, ImageTy * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -7932,17 +6835,18 @@ public ApiResponse headPersonImageByIndexWithHttpInfo(String name, ImageTy 404 Item not found. - */ - public okhttp3.Call headPersonImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headPersonImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headPersonImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + okhttp3.Call localVarCall = headPersonImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for headStudioImage - * @param name Studio name. (required) + * Build call for headPersonImageByIndex + * @param name Person name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -7954,12 +6858,9 @@ public okhttp3.Call headPersonImageByIndexAsync(String name, ImageType imageType * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -7971,7 +6872,7 @@ public okhttp3.Call headPersonImageByIndexAsync(String name, ImageType imageType 404 Item not found. - */ - public okhttp3.Call headStudioImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headPersonImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -7988,9 +6889,10 @@ public okhttp3.Call headStudioImageCall(String name, ImageType imageType, String Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Studios/{name}/Images/{imageType}" + String localVarPath = "/Persons/{name}/Images/{imageType}/{imageIndex}" .replace("{" + "name" + "}", localVarApiClient.escapeString(name.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())); + .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) + .replace("{" + "imageIndex" + "}", localVarApiClient.escapeString(imageIndex.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -8042,14 +6944,6 @@ public okhttp3.Call headStudioImageCall(String name, ImageType imageType, String localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -8062,10 +6956,6 @@ public okhttp3.Call headStudioImageCall(String name, ImageType imageType, String localVarQueryParams.addAll(localVarApiClient.parameterToPair("foregroundLayer", foregroundLayer)); } - if (imageIndex != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("imageIndex", imageIndex)); - } - final String[] localVarAccepts = { "image/*", "application/json", @@ -8089,26 +6979,32 @@ public okhttp3.Call headStudioImageCall(String name, ImageType imageType, String } @SuppressWarnings("rawtypes") - private okhttp3.Call headStudioImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + private okhttp3.Call headPersonImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { - throw new ApiException("Missing the required parameter 'name' when calling headStudioImage(Async)"); + throw new ApiException("Missing the required parameter 'name' when calling headPersonImageByIndex(Async)"); } // verify the required parameter 'imageType' is set if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling headStudioImage(Async)"); + throw new ApiException("Missing the required parameter 'imageType' when calling headPersonImageByIndex(Async)"); + } + + // verify the required parameter 'imageIndex' is set + if (imageIndex == null) { + throw new ApiException("Missing the required parameter 'imageIndex' when calling headPersonImageByIndex(Async)"); } - return headStudioImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + return headPersonImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); } /** - * Get studio image by name. + * Get person image by name. * - * @param name Studio name. (required) + * @param name Person name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -8120,12 +7016,9 @@ private okhttp3.Call headStudioImageValidateBeforeCall(String name, ImageType im * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -8136,16 +7029,17 @@ private okhttp3.Call headStudioImageValidateBeforeCall(String name, ImageType im 404 Item not found. - */ - public File headStudioImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - ApiResponse localVarResp = headStudioImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex); + public File headPersonImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + ApiResponse localVarResp = headPersonImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); return localVarResp.getData(); } /** - * Get studio image by name. + * Get person image by name. * - * @param name Studio name. (required) + * @param name Person name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -8157,12 +7051,9 @@ public File headStudioImage(String name, ImageType imageType, String tag, ImageF * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -8173,17 +7064,18 @@ public File headStudioImage(String name, ImageType imageType, String tag, ImageF 404 Item not found. - */ - public ApiResponse headStudioImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - okhttp3.Call localVarCall = headStudioImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, null); + public ApiResponse headPersonImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + okhttp3.Call localVarCall = headPersonImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Get studio image by name. (asynchronously) + * Get person image by name. (asynchronously) * - * @param name Studio name. (required) + * @param name Person name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -8195,12 +7087,9 @@ public ApiResponse headStudioImageWithHttpInfo(String name, ImageType imag * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -8212,18 +7101,17 @@ public ApiResponse headStudioImageWithHttpInfo(String name, ImageType imag 404 Item not found. - */ - public okhttp3.Call headStudioImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headPersonImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headStudioImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + okhttp3.Call localVarCall = headPersonImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for headStudioImageByIndex + * Build call for headStudioImage * @param name Studio name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -8235,11 +7123,10 @@ public okhttp3.Call headStudioImageAsync(String name, ImageType imageType, Strin * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -8251,7 +7138,7 @@ public okhttp3.Call headStudioImageAsync(String name, ImageType imageType, Strin 404 Item not found. - */ - public okhttp3.Call headStudioImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headStudioImageCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -8268,10 +7155,9 @@ public okhttp3.Call headStudioImageByIndexCall(String name, ImageType imageType, Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Studios/{name}/Images/{imageType}/{imageIndex}" + String localVarPath = "/Studios/{name}/Images/{imageType}" .replace("{" + "name" + "}", localVarApiClient.escapeString(name.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) - .replace("{" + "imageIndex" + "}", localVarApiClient.escapeString(imageIndex.toString())); + .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -8323,14 +7209,6 @@ public okhttp3.Call headStudioImageByIndexCall(String name, ImageType imageType, localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -8343,6 +7221,10 @@ public okhttp3.Call headStudioImageByIndexCall(String name, ImageType imageType, localVarQueryParams.addAll(localVarApiClient.parameterToPair("foregroundLayer", foregroundLayer)); } + if (imageIndex != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("imageIndex", imageIndex)); + } + final String[] localVarAccepts = { "image/*", "application/json", @@ -8366,23 +7248,18 @@ public okhttp3.Call headStudioImageByIndexCall(String name, ImageType imageType, } @SuppressWarnings("rawtypes") - private okhttp3.Call headStudioImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + private okhttp3.Call headStudioImageValidateBeforeCall(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { // verify the required parameter 'name' is set if (name == null) { - throw new ApiException("Missing the required parameter 'name' when calling headStudioImageByIndex(Async)"); + throw new ApiException("Missing the required parameter 'name' when calling headStudioImage(Async)"); } // verify the required parameter 'imageType' is set if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling headStudioImageByIndex(Async)"); - } - - // verify the required parameter 'imageIndex' is set - if (imageIndex == null) { - throw new ApiException("Missing the required parameter 'imageIndex' when calling headStudioImageByIndex(Async)"); + throw new ApiException("Missing the required parameter 'imageType' when calling headStudioImage(Async)"); } - return headStudioImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + return headStudioImageCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); } @@ -8391,7 +7268,6 @@ private okhttp3.Call headStudioImageByIndexValidateBeforeCall(String name, Image * * @param name Studio name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -8403,11 +7279,10 @@ private okhttp3.Call headStudioImageByIndexValidateBeforeCall(String name, Image * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -8418,8 +7293,8 @@ private okhttp3.Call headStudioImageByIndexValidateBeforeCall(String name, Image 404 Item not found. - */ - public File headStudioImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = headStudioImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer); + public File headStudioImage(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + ApiResponse localVarResp = headStudioImageWithHttpInfo(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); return localVarResp.getData(); } @@ -8428,7 +7303,6 @@ public File headStudioImageByIndex(String name, ImageType imageType, Integer ima * * @param name Studio name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -8440,11 +7314,10 @@ public File headStudioImageByIndex(String name, ImageType imageType, Integer ima * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -8455,8 +7328,8 @@ public File headStudioImageByIndex(String name, ImageType imageType, Integer ima 404 Item not found. - */ - public ApiResponse headStudioImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = headStudioImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, null); + public ApiResponse headStudioImageWithHttpInfo(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + okhttp3.Call localVarCall = headStudioImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -8466,7 +7339,6 @@ public ApiResponse headStudioImageByIndexWithHttpInfo(String name, ImageTy * * @param name Studio name. (required) * @param imageType Image type. (required) - * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -8478,11 +7350,10 @@ public ApiResponse headStudioImageByIndexWithHttpInfo(String name, ImageTy * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -8494,17 +7365,18 @@ public ApiResponse headStudioImageByIndexWithHttpInfo(String name, ImageTy 404 Item not found. - */ - public okhttp3.Call headStudioImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headStudioImageAsync(String name, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headStudioImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + okhttp3.Call localVarCall = headStudioImageValidateBeforeCall(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for headUserImage - * @param userId User id. (required) + * Build call for headStudioImageByIndex + * @param name Studio name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -8516,12 +7388,9 @@ public okhttp3.Call headStudioImageByIndexAsync(String name, ImageType imageType * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -8533,7 +7402,7 @@ public okhttp3.Call headStudioImageByIndexAsync(String name, ImageType imageType 404 Item not found. - */ - public okhttp3.Call headUserImageCall(UUID userId, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headStudioImageByIndexCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -8550,9 +7419,10 @@ public okhttp3.Call headUserImageCall(UUID userId, ImageType imageType, String t Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/Images/{imageType}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())); + String localVarPath = "/Studios/{name}/Images/{imageType}/{imageIndex}" + .replace("{" + "name" + "}", localVarApiClient.escapeString(name.toString())) + .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) + .replace("{" + "imageIndex" + "}", localVarApiClient.escapeString(imageIndex.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -8604,14 +7474,6 @@ public okhttp3.Call headUserImageCall(UUID userId, ImageType imageType, String t localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -8624,10 +7486,6 @@ public okhttp3.Call headUserImageCall(UUID userId, ImageType imageType, String t localVarQueryParams.addAll(localVarApiClient.parameterToPair("foregroundLayer", foregroundLayer)); } - if (imageIndex != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("imageIndex", imageIndex)); - } - final String[] localVarAccepts = { "image/*", "application/json", @@ -8651,26 +7509,32 @@ public okhttp3.Call headUserImageCall(UUID userId, ImageType imageType, String t } @SuppressWarnings("rawtypes") - private okhttp3.Call headUserImageValidateBeforeCall(UUID userId, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling headUserImage(Async)"); + private okhttp3.Call headStudioImageByIndexValidateBeforeCall(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'name' is set + if (name == null) { + throw new ApiException("Missing the required parameter 'name' when calling headStudioImageByIndex(Async)"); } // verify the required parameter 'imageType' is set if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling headUserImage(Async)"); + throw new ApiException("Missing the required parameter 'imageType' when calling headStudioImageByIndex(Async)"); } - return headUserImageCall(userId, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + // verify the required parameter 'imageIndex' is set + if (imageIndex == null) { + throw new ApiException("Missing the required parameter 'imageIndex' when calling headStudioImageByIndex(Async)"); + } + + return headStudioImageByIndexCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); } /** - * Get user profile image. + * Get studio image by name. * - * @param userId User id. (required) + * @param name Studio name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -8682,12 +7546,9 @@ private okhttp3.Call headUserImageValidateBeforeCall(UUID userId, ImageType imag * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -8698,16 +7559,17 @@ private okhttp3.Call headUserImageValidateBeforeCall(UUID userId, ImageType imag 404 Item not found. - */ - public File headUserImage(UUID userId, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - ApiResponse localVarResp = headUserImageWithHttpInfo(userId, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex); + public File headStudioImageByIndex(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + ApiResponse localVarResp = headStudioImageByIndexWithHttpInfo(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer); return localVarResp.getData(); } /** - * Get user profile image. + * Get studio image by name. * - * @param userId User id. (required) + * @param name Studio name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -8719,12 +7581,9 @@ public File headUserImage(UUID userId, ImageType imageType, String tag, ImageFor * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -8735,17 +7594,18 @@ public File headUserImage(UUID userId, ImageType imageType, String tag, ImageFor 404 Item not found. - */ - public ApiResponse headUserImageWithHttpInfo(UUID userId, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { - okhttp3.Call localVarCall = headUserImageValidateBeforeCall(userId, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, null); + public ApiResponse headStudioImageByIndexWithHttpInfo(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { + okhttp3.Call localVarCall = headStudioImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Get user profile image. (asynchronously) + * Get studio image by name. (asynchronously) * - * @param userId User id. (required) + * @param name Studio name. (required) * @param imageType Image type. (required) + * @param imageIndex Image index. (required) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -8757,12 +7617,9 @@ public ApiResponse headUserImageWithHttpInfo(UUID userId, ImageType imageT * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) - * @param imageIndex Image index. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -8774,18 +7631,16 @@ public ApiResponse headUserImageWithHttpInfo(UUID userId, ImageType imageT 404 Item not found. - */ - public okhttp3.Call headUserImageAsync(UUID userId, ImageType imageType, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headStudioImageByIndexAsync(String name, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headUserImageValidateBeforeCall(userId, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, _callback); + okhttp3.Call localVarCall = headStudioImageByIndexValidateBeforeCall(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for headUserImageByIndex - * @param userId User id. (required) - * @param imageType Image type. (required) - * @param imageIndex Image index. (required) + * Build call for headUserImage + * @param userId User id. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -8797,11 +7652,10 @@ public okhttp3.Call headUserImageAsync(UUID userId, ImageType imageType, String * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -8810,10 +7664,11 @@ public okhttp3.Call headUserImageAsync(UUID userId, ImageType imageType, String Response Details Status Code Description Response Headers 200 Image stream returned. - + 400 User id not provided. - 404 Item not found. - */ - public okhttp3.Call headUserImageByIndexCall(UUID userId, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headUserImageCall(UUID userId, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -8830,10 +7685,7 @@ public okhttp3.Call headUserImageByIndexCall(UUID userId, ImageType imageType, I Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/Images/{imageType}/{imageIndex}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) - .replace("{" + "imageIndex" + "}", localVarApiClient.escapeString(imageIndex.toString())); + String localVarPath = "/UserImage"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -8841,6 +7693,10 @@ public okhttp3.Call headUserImageByIndexCall(UUID userId, ImageType imageType, I Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + if (tag != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("tag", tag)); } @@ -8885,14 +7741,6 @@ public okhttp3.Call headUserImageByIndexCall(UUID userId, ImageType imageType, I localVarQueryParams.addAll(localVarApiClient.parameterToPair("fillHeight", fillHeight)); } - if (cropWhitespace != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("cropWhitespace", cropWhitespace)); - } - - if (addPlayedIndicator != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("addPlayedIndicator", addPlayedIndicator)); - } - if (blur != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("blur", blur)); } @@ -8905,6 +7753,10 @@ public okhttp3.Call headUserImageByIndexCall(UUID userId, ImageType imageType, I localVarQueryParams.addAll(localVarApiClient.parameterToPair("foregroundLayer", foregroundLayer)); } + if (imageIndex != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("imageIndex", imageIndex)); + } + final String[] localVarAccepts = { "image/*", "application/json", @@ -8928,32 +7780,15 @@ public okhttp3.Call headUserImageByIndexCall(UUID userId, ImageType imageType, I } @SuppressWarnings("rawtypes") - private okhttp3.Call headUserImageByIndexValidateBeforeCall(UUID userId, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling headUserImageByIndex(Async)"); - } - - // verify the required parameter 'imageType' is set - if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling headUserImageByIndex(Async)"); - } - - // verify the required parameter 'imageIndex' is set - if (imageIndex == null) { - throw new ApiException("Missing the required parameter 'imageIndex' when calling headUserImageByIndex(Async)"); - } - - return headUserImageByIndexCall(userId, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + private okhttp3.Call headUserImageValidateBeforeCall(UUID userId, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { + return headUserImageCall(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); } /** * Get user profile image. * - * @param userId User id. (required) - * @param imageType Image type. (required) - * @param imageIndex Image index. (required) + * @param userId User id. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -8965,11 +7800,10 @@ private okhttp3.Call headUserImageByIndexValidateBeforeCall(UUID userId, ImageTy * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -8977,20 +7811,19 @@ private okhttp3.Call headUserImageByIndexValidateBeforeCall(UUID userId, ImageTy Response Details Status Code Description Response Headers 200 Image stream returned. - + 400 User id not provided. - 404 Item not found. - */ - public File headUserImageByIndex(UUID userId, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - ApiResponse localVarResp = headUserImageByIndexWithHttpInfo(userId, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer); + public File headUserImage(UUID userId, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + ApiResponse localVarResp = headUserImageWithHttpInfo(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex); return localVarResp.getData(); } /** * Get user profile image. * - * @param userId User id. (required) - * @param imageType Image type. (required) - * @param imageIndex Image index. (required) + * @param userId User id. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -9002,11 +7835,10 @@ public File headUserImageByIndex(UUID userId, ImageType imageType, Integer image * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -9014,11 +7846,12 @@ public File headUserImageByIndex(UUID userId, ImageType imageType, Integer image Response Details Status Code Description Response Headers 200 Image stream returned. - + 400 User id not provided. - 404 Item not found. - */ - public ApiResponse headUserImageByIndexWithHttpInfo(UUID userId, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer) throws ApiException { - okhttp3.Call localVarCall = headUserImageByIndexValidateBeforeCall(userId, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, null); + public ApiResponse headUserImageWithHttpInfo(UUID userId, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex) throws ApiException { + okhttp3.Call localVarCall = headUserImageValidateBeforeCall(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -9026,9 +7859,7 @@ public ApiResponse headUserImageByIndexWithHttpInfo(UUID userId, ImageType /** * Get user profile image. (asynchronously) * - * @param userId User id. (required) - * @param imageType Image type. (required) - * @param imageIndex Image index. (required) + * @param userId User id. (optional) * @param tag Optional. Supply the cache tag from the item object to receive strong caching headers. (optional) * @param format Determines the output format of the image - original,gif,jpg,png. (optional) * @param maxWidth The maximum image width to return. (optional) @@ -9040,11 +7871,10 @@ public ApiResponse headUserImageByIndexWithHttpInfo(UUID userId, ImageType * @param quality Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. (optional) * @param fillWidth Width of box to fill. (optional) * @param fillHeight Height of box to fill. (optional) - * @param cropWhitespace Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. (optional) - * @param addPlayedIndicator Optional. Add a played indicator. (optional) * @param blur Optional. Blur image. (optional) * @param backgroundColor Optional. Apply a background color for transparent images. (optional) * @param foregroundLayer Optional. Apply a foreground layer on top of the image. (optional) + * @param imageIndex Image index. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -9053,21 +7883,20 @@ public ApiResponse headUserImageByIndexWithHttpInfo(UUID userId, ImageType Response Details Status Code Description Response Headers 200 Image stream returned. - + 400 User id not provided. - 404 Item not found. - */ - public okhttp3.Call headUserImageByIndexAsync(UUID userId, ImageType imageType, Integer imageIndex, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Boolean cropWhitespace, Boolean addPlayedIndicator, Integer blur, String backgroundColor, String foregroundLayer, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headUserImageAsync(UUID userId, String tag, ImageFormat format, Integer maxWidth, Integer maxHeight, Double percentPlayed, Integer unplayedCount, Integer width, Integer height, Integer quality, Integer fillWidth, Integer fillHeight, Integer blur, String backgroundColor, String foregroundLayer, Integer imageIndex, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headUserImageByIndexValidateBeforeCall(userId, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, _callback); + okhttp3.Call localVarCall = headUserImageValidateBeforeCall(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for postUserImage - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (optional) + * @param userId User Id. (optional) * @param body (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -9077,11 +7906,13 @@ public okhttp3.Call headUserImageByIndexAsync(UUID userId, ImageType imageType, Response Details Status Code Description Response Headers 204 Image updated. - + 400 Bad Request - 403 User does not have permission to delete the image. - + 404 Item not found. - 401 Unauthorized - */ - public okhttp3.Call postUserImageCall(UUID userId, ImageType imageType, Integer index, File body, final ApiCallback _callback) throws ApiException { + public okhttp3.Call postUserImageCall(UUID userId, File body, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -9098,9 +7929,7 @@ public okhttp3.Call postUserImageCall(UUID userId, ImageType imageType, Integer Object localVarPostBody = body; // create path and map variables - String localVarPath = "/Users/{userId}/Images/{imageType}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())); + String localVarPath = "/UserImage"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -9108,163 +7937,10 @@ public okhttp3.Call postUserImageCall(UUID userId, ImageType imageType, Integer Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); - if (index != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("index", index)); - } - - final String[] localVarAccepts = { - "application/json", - "application/json; profile=CamelCase", - "application/json; profile=PascalCase" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - "image/*" - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - if (localVarContentType != null) { - localVarHeaderParams.put("Content-Type", localVarContentType); - } - - String[] localVarAuthNames = new String[] { "CustomAuthentication" }; - return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call postUserImageValidateBeforeCall(UUID userId, ImageType imageType, Integer index, File body, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling postUserImage(Async)"); - } - - // verify the required parameter 'imageType' is set - if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling postUserImage(Async)"); - } - - return postUserImageCall(userId, imageType, index, body, _callback); - - } - - /** - * Sets the user image. - * - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (optional) - * @param body (optional) - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
204 Image updated. -
403 User does not have permission to delete the image. -
401 Unauthorized -
- */ - public void postUserImage(UUID userId, ImageType imageType, Integer index, File body) throws ApiException { - postUserImageWithHttpInfo(userId, imageType, index, body); - } - - /** - * Sets the user image. - * - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (optional) - * @param body (optional) - * @return ApiResponse<Void> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
204 Image updated. -
403 User does not have permission to delete the image. -
401 Unauthorized -
- */ - public ApiResponse postUserImageWithHttpInfo(UUID userId, ImageType imageType, Integer index, File body) throws ApiException { - okhttp3.Call localVarCall = postUserImageValidateBeforeCall(userId, imageType, index, body, null); - return localVarApiClient.execute(localVarCall); - } - - /** - * Sets the user image. (asynchronously) - * - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (optional) - * @param body (optional) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
204 Image updated. -
403 User does not have permission to delete the image. -
401 Unauthorized -
- */ - public okhttp3.Call postUserImageAsync(UUID userId, ImageType imageType, Integer index, File body, final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = postUserImageValidateBeforeCall(userId, imageType, index, body, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); - return localVarCall; - } - /** - * Build call for postUserImageByIndex - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (required) - * @param body (optional) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
204 Image updated. -
403 User does not have permission to delete the image. -
401 Unauthorized -
- */ - public okhttp3.Call postUserImageByIndexCall(UUID userId, ImageType imageType, Integer index, File body, final ApiCallback _callback) throws ApiException { - String basePath = null; - // Operation Servers - String[] localBasePaths = new String[] { }; - - // Determine Base Path to Use - if (localCustomBaseUrl != null){ - basePath = localCustomBaseUrl; - } else if ( localBasePaths.length > 0 ) { - basePath = localBasePaths[localHostIndex]; - } else { - basePath = null; + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); } - Object localVarPostBody = body; - - // create path and map variables - String localVarPath = "/Users/{userId}/Images/{imageType}/{index}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) - .replace("{" + "imageType" + "}", localVarApiClient.escapeString(imageType.toString())) - .replace("{" + "index" + "}", localVarApiClient.escapeString(index.toString())); - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -9288,32 +7964,15 @@ public okhttp3.Call postUserImageByIndexCall(UUID userId, ImageType imageType, I } @SuppressWarnings("rawtypes") - private okhttp3.Call postUserImageByIndexValidateBeforeCall(UUID userId, ImageType imageType, Integer index, File body, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling postUserImageByIndex(Async)"); - } - - // verify the required parameter 'imageType' is set - if (imageType == null) { - throw new ApiException("Missing the required parameter 'imageType' when calling postUserImageByIndex(Async)"); - } - - // verify the required parameter 'index' is set - if (index == null) { - throw new ApiException("Missing the required parameter 'index' when calling postUserImageByIndex(Async)"); - } - - return postUserImageByIndexCall(userId, imageType, index, body, _callback); + private okhttp3.Call postUserImageValidateBeforeCall(UUID userId, File body, final ApiCallback _callback) throws ApiException { + return postUserImageCall(userId, body, _callback); } /** * Sets the user image. * - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (required) + * @param userId User Id. (optional) * @param body (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -9321,20 +7980,20 @@ private okhttp3.Call postUserImageByIndexValidateBeforeCall(UUID userId, ImageTy Response Details Status Code Description Response Headers 204 Image updated. - + 400 Bad Request - 403 User does not have permission to delete the image. - + 404 Item not found. - 401 Unauthorized - */ - public void postUserImageByIndex(UUID userId, ImageType imageType, Integer index, File body) throws ApiException { - postUserImageByIndexWithHttpInfo(userId, imageType, index, body); + public void postUserImage(UUID userId, File body) throws ApiException { + postUserImageWithHttpInfo(userId, body); } /** * Sets the user image. * - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (required) + * @param userId User Id. (optional) * @param body (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -9343,21 +8002,21 @@ public void postUserImageByIndex(UUID userId, ImageType imageType, Integer index Response Details Status Code Description Response Headers 204 Image updated. - + 400 Bad Request - 403 User does not have permission to delete the image. - + 404 Item not found. - 401 Unauthorized - */ - public ApiResponse postUserImageByIndexWithHttpInfo(UUID userId, ImageType imageType, Integer index, File body) throws ApiException { - okhttp3.Call localVarCall = postUserImageByIndexValidateBeforeCall(userId, imageType, index, body, null); + public ApiResponse postUserImageWithHttpInfo(UUID userId, File body) throws ApiException { + okhttp3.Call localVarCall = postUserImageValidateBeforeCall(userId, body, null); return localVarApiClient.execute(localVarCall); } /** * Sets the user image. (asynchronously) * - * @param userId User Id. (required) - * @param imageType (Unused) Image type. (required) - * @param index (Unused) Image index. (required) + * @param userId User Id. (optional) * @param body (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -9367,13 +8026,15 @@ public ApiResponse postUserImageByIndexWithHttpInfo(UUID userId, ImageType Response Details Status Code Description Response Headers 204 Image updated. - + 400 Bad Request - 403 User does not have permission to delete the image. - + 404 Item not found. - 401 Unauthorized - */ - public okhttp3.Call postUserImageByIndexAsync(UUID userId, ImageType imageType, Integer index, File body, final ApiCallback _callback) throws ApiException { + public okhttp3.Call postUserImageAsync(UUID userId, File body, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = postUserImageByIndexValidateBeforeCall(userId, imageType, index, body, _callback); + okhttp3.Call localVarCall = postUserImageValidateBeforeCall(userId, body, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } @@ -9390,6 +8051,7 @@ public okhttp3.Call postUserImageByIndexAsync(UUID userId, ImageType imageType, Response Details Status Code Description Response Headers 204 Image saved. - + 400 Bad Request - 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -9472,6 +8134,7 @@ private okhttp3.Call setItemImageValidateBeforeCall(UUID itemId, ImageType image Response Details Status Code Description Response Headers 204 Image saved. - + 400 Bad Request - 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -9494,6 +8157,7 @@ public void setItemImage(UUID itemId, ImageType imageType, File body) throws Api Response Details Status Code Description Response Headers 204 Image saved. - + 400 Bad Request - 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -9518,6 +8182,7 @@ public ApiResponse setItemImageWithHttpInfo(UUID itemId, ImageType imageTy Response Details Status Code Description Response Headers 204 Image saved. - + 400 Bad Request - 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -9543,6 +8208,7 @@ public okhttp3.Call setItemImageAsync(UUID itemId, ImageType imageType, File bod Response Details Status Code Description Response Headers 204 Image saved. - + 400 Bad Request - 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -9632,6 +8298,7 @@ private okhttp3.Call setItemImageByIndexValidateBeforeCall(UUID itemId, ImageTyp Response Details Status Code Description Response Headers 204 Image saved. - + 400 Bad Request - 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -9655,6 +8322,7 @@ public void setItemImageByIndex(UUID itemId, ImageType imageType, Integer imageI Response Details Status Code Description Response Headers 204 Image saved. - + 400 Bad Request - 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -9680,6 +8348,7 @@ public ApiResponse setItemImageByIndexWithHttpInfo(UUID itemId, ImageType Response Details Status Code Description Response Headers 204 Image saved. - + 400 Bad Request - 404 Item not found. - 401 Unauthorized - 403 Forbidden - diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/InstantMixApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/InstantMixApi.java similarity index 87% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/InstantMixApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/InstantMixApi.java index 2a709a64f0217..fd00aa5459fb0 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/InstantMixApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/InstantMixApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -30,6 +30,7 @@ import org.openapitools.client.model.BaseItemDtoQueryResult; import org.openapitools.client.model.ImageType; import org.openapitools.client.model.ItemFields; +import org.openapitools.client.model.ProblemDetails; import java.util.UUID; import java.lang.reflect.Type; @@ -77,7 +78,7 @@ public void setCustomBaseUrl(String customBaseUrl) { /** * Build call for getInstantMixFromAlbum - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -93,11 +94,12 @@ public void setCustomBaseUrl(String customBaseUrl) { Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call getInstantMixFromAlbumCall(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getInstantMixFromAlbumCall(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -114,8 +116,8 @@ public okhttp3.Call getInstantMixFromAlbumCall(UUID id, UUID userId, Integer lim Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Albums/{id}/InstantMix" - .replace("{" + "id" + "}", localVarApiClient.escapeString(id.toString())); + String localVarPath = "/Albums/{itemId}/InstantMix" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -173,20 +175,20 @@ public okhttp3.Call getInstantMixFromAlbumCall(UUID id, UUID userId, Integer lim } @SuppressWarnings("rawtypes") - private okhttp3.Call getInstantMixFromAlbumValidateBeforeCall(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException("Missing the required parameter 'id' when calling getInstantMixFromAlbum(Async)"); + private okhttp3.Call getInstantMixFromAlbumValidateBeforeCall(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling getInstantMixFromAlbum(Async)"); } - return getInstantMixFromAlbumCall(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); + return getInstantMixFromAlbumCall(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); } /** * Creates an instant playlist based on a given album. * - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -201,19 +203,20 @@ private okhttp3.Call getInstantMixFromAlbumValidateBeforeCall(UUID id, UUID user Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public BaseItemDtoQueryResult getInstantMixFromAlbum(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { - ApiResponse localVarResp = getInstantMixFromAlbumWithHttpInfo(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); + public BaseItemDtoQueryResult getInstantMixFromAlbum(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { + ApiResponse localVarResp = getInstantMixFromAlbumWithHttpInfo(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); return localVarResp.getData(); } /** * Creates an instant playlist based on a given album. * - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -228,12 +231,13 @@ public BaseItemDtoQueryResult getInstantMixFromAlbum(UUID id, UUID userId, Integ Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public ApiResponse getInstantMixFromAlbumWithHttpInfo(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { - okhttp3.Call localVarCall = getInstantMixFromAlbumValidateBeforeCall(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, null); + public ApiResponse getInstantMixFromAlbumWithHttpInfo(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { + okhttp3.Call localVarCall = getInstantMixFromAlbumValidateBeforeCall(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -241,7 +245,7 @@ public ApiResponse getInstantMixFromAlbumWithHttpInfo(UU /** * Creates an instant playlist based on a given album. (asynchronously) * - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -257,20 +261,21 @@ public ApiResponse getInstantMixFromAlbumWithHttpInfo(UU Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call getInstantMixFromAlbumAsync(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getInstantMixFromAlbumAsync(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getInstantMixFromAlbumValidateBeforeCall(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); + okhttp3.Call localVarCall = getInstantMixFromAlbumValidateBeforeCall(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getInstantMixFromArtists - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -286,11 +291,12 @@ public okhttp3.Call getInstantMixFromAlbumAsync(UUID id, UUID userId, Integer li Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call getInstantMixFromArtistsCall(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getInstantMixFromArtistsCall(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -307,8 +313,8 @@ public okhttp3.Call getInstantMixFromArtistsCall(UUID id, UUID userId, Integer l Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Artists/{id}/InstantMix" - .replace("{" + "id" + "}", localVarApiClient.escapeString(id.toString())); + String localVarPath = "/Artists/{itemId}/InstantMix" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -366,20 +372,20 @@ public okhttp3.Call getInstantMixFromArtistsCall(UUID id, UUID userId, Integer l } @SuppressWarnings("rawtypes") - private okhttp3.Call getInstantMixFromArtistsValidateBeforeCall(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException("Missing the required parameter 'id' when calling getInstantMixFromArtists(Async)"); + private okhttp3.Call getInstantMixFromArtistsValidateBeforeCall(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling getInstantMixFromArtists(Async)"); } - return getInstantMixFromArtistsCall(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); + return getInstantMixFromArtistsCall(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); } /** * Creates an instant playlist based on a given artist. * - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -394,19 +400,20 @@ private okhttp3.Call getInstantMixFromArtistsValidateBeforeCall(UUID id, UUID us Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public BaseItemDtoQueryResult getInstantMixFromArtists(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { - ApiResponse localVarResp = getInstantMixFromArtistsWithHttpInfo(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); + public BaseItemDtoQueryResult getInstantMixFromArtists(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { + ApiResponse localVarResp = getInstantMixFromArtistsWithHttpInfo(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); return localVarResp.getData(); } /** * Creates an instant playlist based on a given artist. * - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -421,12 +428,13 @@ public BaseItemDtoQueryResult getInstantMixFromArtists(UUID id, UUID userId, Int Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public ApiResponse getInstantMixFromArtistsWithHttpInfo(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { - okhttp3.Call localVarCall = getInstantMixFromArtistsValidateBeforeCall(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, null); + public ApiResponse getInstantMixFromArtistsWithHttpInfo(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { + okhttp3.Call localVarCall = getInstantMixFromArtistsValidateBeforeCall(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -434,7 +442,7 @@ public ApiResponse getInstantMixFromArtistsWithHttpInfo( /** * Creates an instant playlist based on a given artist. (asynchronously) * - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -450,13 +458,14 @@ public ApiResponse getInstantMixFromArtistsWithHttpInfo( Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call getInstantMixFromArtistsAsync(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getInstantMixFromArtistsAsync(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getInstantMixFromArtistsValidateBeforeCall(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); + okhttp3.Call localVarCall = getInstantMixFromArtistsValidateBeforeCall(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -479,6 +488,7 @@ public okhttp3.Call getInstantMixFromArtistsAsync(UUID id, UUID userId, Integer Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -593,6 +603,7 @@ private okhttp3.Call getInstantMixFromArtists2ValidateBeforeCall(UUID id, UUID u Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -622,6 +633,7 @@ public BaseItemDtoQueryResult getInstantMixFromArtists2(UUID id, UUID userId, In Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -653,6 +665,7 @@ public ApiResponse getInstantMixFromArtists2WithHttpInfo Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -668,7 +681,7 @@ public okhttp3.Call getInstantMixFromArtists2Async(UUID id, UUID userId, Integer } /** * Build call for getInstantMixFromItem - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -684,11 +697,12 @@ public okhttp3.Call getInstantMixFromArtists2Async(UUID id, UUID userId, Integer Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call getInstantMixFromItemCall(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getInstantMixFromItemCall(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -705,8 +719,8 @@ public okhttp3.Call getInstantMixFromItemCall(UUID id, UUID userId, Integer limi Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Items/{id}/InstantMix" - .replace("{" + "id" + "}", localVarApiClient.escapeString(id.toString())); + String localVarPath = "/Items/{itemId}/InstantMix" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -764,20 +778,20 @@ public okhttp3.Call getInstantMixFromItemCall(UUID id, UUID userId, Integer limi } @SuppressWarnings("rawtypes") - private okhttp3.Call getInstantMixFromItemValidateBeforeCall(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException("Missing the required parameter 'id' when calling getInstantMixFromItem(Async)"); + private okhttp3.Call getInstantMixFromItemValidateBeforeCall(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling getInstantMixFromItem(Async)"); } - return getInstantMixFromItemCall(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); + return getInstantMixFromItemCall(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); } /** * Creates an instant playlist based on a given item. * - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -792,19 +806,20 @@ private okhttp3.Call getInstantMixFromItemValidateBeforeCall(UUID id, UUID userI Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public BaseItemDtoQueryResult getInstantMixFromItem(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { - ApiResponse localVarResp = getInstantMixFromItemWithHttpInfo(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); + public BaseItemDtoQueryResult getInstantMixFromItem(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { + ApiResponse localVarResp = getInstantMixFromItemWithHttpInfo(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); return localVarResp.getData(); } /** * Creates an instant playlist based on a given item. * - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -819,12 +834,13 @@ public BaseItemDtoQueryResult getInstantMixFromItem(UUID id, UUID userId, Intege Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public ApiResponse getInstantMixFromItemWithHttpInfo(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { - okhttp3.Call localVarCall = getInstantMixFromItemValidateBeforeCall(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, null); + public ApiResponse getInstantMixFromItemWithHttpInfo(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { + okhttp3.Call localVarCall = getInstantMixFromItemValidateBeforeCall(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -832,7 +848,7 @@ public ApiResponse getInstantMixFromItemWithHttpInfo(UUI /** * Creates an instant playlist based on a given item. (asynchronously) * - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -848,13 +864,14 @@ public ApiResponse getInstantMixFromItemWithHttpInfo(UUI Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call getInstantMixFromItemAsync(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getInstantMixFromItemAsync(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getInstantMixFromItemValidateBeforeCall(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); + okhttp3.Call localVarCall = getInstantMixFromItemValidateBeforeCall(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -877,6 +894,7 @@ public okhttp3.Call getInstantMixFromItemAsync(UUID id, UUID userId, Integer lim Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -988,6 +1006,7 @@ private okhttp3.Call getInstantMixFromMusicGenreByIdValidateBeforeCall(UUID id, Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1015,6 +1034,7 @@ public BaseItemDtoQueryResult getInstantMixFromMusicGenreById(UUID id, UUID user Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1044,6 +1064,7 @@ public ApiResponse getInstantMixFromMusicGenreByIdWithHt Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1250,7 +1271,7 @@ public okhttp3.Call getInstantMixFromMusicGenreByNameAsync(String name, UUID use } /** * Build call for getInstantMixFromPlaylist - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -1266,11 +1287,12 @@ public okhttp3.Call getInstantMixFromMusicGenreByNameAsync(String name, UUID use Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call getInstantMixFromPlaylistCall(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getInstantMixFromPlaylistCall(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1287,8 +1309,8 @@ public okhttp3.Call getInstantMixFromPlaylistCall(UUID id, UUID userId, Integer Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Playlists/{id}/InstantMix" - .replace("{" + "id" + "}", localVarApiClient.escapeString(id.toString())); + String localVarPath = "/Playlists/{itemId}/InstantMix" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -1346,20 +1368,20 @@ public okhttp3.Call getInstantMixFromPlaylistCall(UUID id, UUID userId, Integer } @SuppressWarnings("rawtypes") - private okhttp3.Call getInstantMixFromPlaylistValidateBeforeCall(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException("Missing the required parameter 'id' when calling getInstantMixFromPlaylist(Async)"); + private okhttp3.Call getInstantMixFromPlaylistValidateBeforeCall(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling getInstantMixFromPlaylist(Async)"); } - return getInstantMixFromPlaylistCall(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); + return getInstantMixFromPlaylistCall(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); } /** * Creates an instant playlist based on a given playlist. * - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -1374,19 +1396,20 @@ private okhttp3.Call getInstantMixFromPlaylistValidateBeforeCall(UUID id, UUID u Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public BaseItemDtoQueryResult getInstantMixFromPlaylist(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { - ApiResponse localVarResp = getInstantMixFromPlaylistWithHttpInfo(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); + public BaseItemDtoQueryResult getInstantMixFromPlaylist(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { + ApiResponse localVarResp = getInstantMixFromPlaylistWithHttpInfo(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); return localVarResp.getData(); } /** * Creates an instant playlist based on a given playlist. * - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -1401,12 +1424,13 @@ public BaseItemDtoQueryResult getInstantMixFromPlaylist(UUID id, UUID userId, In Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public ApiResponse getInstantMixFromPlaylistWithHttpInfo(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { - okhttp3.Call localVarCall = getInstantMixFromPlaylistValidateBeforeCall(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, null); + public ApiResponse getInstantMixFromPlaylistWithHttpInfo(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { + okhttp3.Call localVarCall = getInstantMixFromPlaylistValidateBeforeCall(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -1414,7 +1438,7 @@ public ApiResponse getInstantMixFromPlaylistWithHttpInfo /** * Creates an instant playlist based on a given playlist. (asynchronously) * - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -1430,20 +1454,21 @@ public ApiResponse getInstantMixFromPlaylistWithHttpInfo Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call getInstantMixFromPlaylistAsync(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getInstantMixFromPlaylistAsync(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getInstantMixFromPlaylistValidateBeforeCall(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); + okhttp3.Call localVarCall = getInstantMixFromPlaylistValidateBeforeCall(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getInstantMixFromSong - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -1459,11 +1484,12 @@ public okhttp3.Call getInstantMixFromPlaylistAsync(UUID id, UUID userId, Integer Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call getInstantMixFromSongCall(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getInstantMixFromSongCall(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1480,8 +1506,8 @@ public okhttp3.Call getInstantMixFromSongCall(UUID id, UUID userId, Integer limi Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Songs/{id}/InstantMix" - .replace("{" + "id" + "}", localVarApiClient.escapeString(id.toString())); + String localVarPath = "/Songs/{itemId}/InstantMix" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -1539,20 +1565,20 @@ public okhttp3.Call getInstantMixFromSongCall(UUID id, UUID userId, Integer limi } @SuppressWarnings("rawtypes") - private okhttp3.Call getInstantMixFromSongValidateBeforeCall(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException("Missing the required parameter 'id' when calling getInstantMixFromSong(Async)"); + private okhttp3.Call getInstantMixFromSongValidateBeforeCall(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling getInstantMixFromSong(Async)"); } - return getInstantMixFromSongCall(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); + return getInstantMixFromSongCall(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); } /** * Creates an instant playlist based on a given song. * - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -1567,19 +1593,20 @@ private okhttp3.Call getInstantMixFromSongValidateBeforeCall(UUID id, UUID userI Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public BaseItemDtoQueryResult getInstantMixFromSong(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { - ApiResponse localVarResp = getInstantMixFromSongWithHttpInfo(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); + public BaseItemDtoQueryResult getInstantMixFromSong(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { + ApiResponse localVarResp = getInstantMixFromSongWithHttpInfo(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); return localVarResp.getData(); } /** * Creates an instant playlist based on a given song. * - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -1594,12 +1621,13 @@ public BaseItemDtoQueryResult getInstantMixFromSong(UUID id, UUID userId, Intege Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public ApiResponse getInstantMixFromSongWithHttpInfo(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { - okhttp3.Call localVarCall = getInstantMixFromSongValidateBeforeCall(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, null); + public ApiResponse getInstantMixFromSongWithHttpInfo(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { + okhttp3.Call localVarCall = getInstantMixFromSongValidateBeforeCall(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -1607,7 +1635,7 @@ public ApiResponse getInstantMixFromSongWithHttpInfo(UUI /** * Creates an instant playlist based on a given song. (asynchronously) * - * @param id The item id. (required) + * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) @@ -1623,13 +1651,14 @@ public ApiResponse getInstantMixFromSongWithHttpInfo(UUI Response Details Status Code Description Response Headers 200 Instant playlist returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call getInstantMixFromSongAsync(UUID id, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getInstantMixFromSongAsync(UUID itemId, UUID userId, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getInstantMixFromSongValidateBeforeCall(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); + okhttp3.Call localVarCall = getInstantMixFromSongValidateBeforeCall(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ItemLookupApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ItemLookupApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ItemLookupApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ItemLookupApi.java index 68f01d0c53678..b15800f453050 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ItemLookupApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ItemLookupApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -97,6 +97,7 @@ public void setCustomBaseUrl(String customBaseUrl) { Response Details Status Code Description Response Headers 204 Item metadata refreshed. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -132,6 +133,9 @@ public okhttp3.Call applySearchCriteriaCall(UUID itemId, RemoteSearchResult remo } final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -180,6 +184,7 @@ private okhttp3.Call applySearchCriteriaValidateBeforeCall(UUID itemId, RemoteSe Response Details Status Code Description Response Headers 204 Item metadata refreshed. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -201,6 +206,7 @@ public void applySearchCriteria(UUID itemId, RemoteSearchResult remoteSearchResu Response Details Status Code Description Response Headers 204 Item metadata refreshed. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -224,6 +230,7 @@ public ApiResponse applySearchCriteriaWithHttpInfo(UUID itemId, RemoteSear Response Details Status Code Description Response Headers 204 Item metadata refreshed. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ItemRefreshApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ItemRefreshApi.java similarity index 87% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ItemRefreshApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ItemRefreshApi.java index 5664f54bc7264..67a7b24f6c6e0 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ItemRefreshApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ItemRefreshApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -81,6 +81,7 @@ public void setCustomBaseUrl(String customBaseUrl) { * @param imageRefreshMode (Optional) Specifies the image refresh mode. (optional, default to None) * @param replaceAllMetadata (Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh. (optional, default to false) * @param replaceAllImages (Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh. (optional, default to false) + * @param regenerateTrickplay (Optional) Determines if trickplay images should be replaced. Only applicable if mode is FullRefresh. (optional, default to false) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -94,7 +95,7 @@ public void setCustomBaseUrl(String customBaseUrl) { 403 Forbidden - */ - public okhttp3.Call refreshItemCall(UUID itemId, MetadataRefreshMode metadataRefreshMode, MetadataRefreshMode imageRefreshMode, Boolean replaceAllMetadata, Boolean replaceAllImages, final ApiCallback _callback) throws ApiException { + public okhttp3.Call refreshItemCall(UUID itemId, MetadataRefreshMode metadataRefreshMode, MetadataRefreshMode imageRefreshMode, Boolean replaceAllMetadata, Boolean replaceAllImages, Boolean regenerateTrickplay, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -136,6 +137,10 @@ public okhttp3.Call refreshItemCall(UUID itemId, MetadataRefreshMode metadataRef localVarQueryParams.addAll(localVarApiClient.parameterToPair("replaceAllImages", replaceAllImages)); } + if (regenerateTrickplay != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("regenerateTrickplay", regenerateTrickplay)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -158,13 +163,13 @@ public okhttp3.Call refreshItemCall(UUID itemId, MetadataRefreshMode metadataRef } @SuppressWarnings("rawtypes") - private okhttp3.Call refreshItemValidateBeforeCall(UUID itemId, MetadataRefreshMode metadataRefreshMode, MetadataRefreshMode imageRefreshMode, Boolean replaceAllMetadata, Boolean replaceAllImages, final ApiCallback _callback) throws ApiException { + private okhttp3.Call refreshItemValidateBeforeCall(UUID itemId, MetadataRefreshMode metadataRefreshMode, MetadataRefreshMode imageRefreshMode, Boolean replaceAllMetadata, Boolean replaceAllImages, Boolean regenerateTrickplay, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling refreshItem(Async)"); } - return refreshItemCall(itemId, metadataRefreshMode, imageRefreshMode, replaceAllMetadata, replaceAllImages, _callback); + return refreshItemCall(itemId, metadataRefreshMode, imageRefreshMode, replaceAllMetadata, replaceAllImages, regenerateTrickplay, _callback); } @@ -176,6 +181,7 @@ private okhttp3.Call refreshItemValidateBeforeCall(UUID itemId, MetadataRefreshM * @param imageRefreshMode (Optional) Specifies the image refresh mode. (optional, default to None) * @param replaceAllMetadata (Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh. (optional, default to false) * @param replaceAllImages (Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh. (optional, default to false) + * @param regenerateTrickplay (Optional) Determines if trickplay images should be replaced. Only applicable if mode is FullRefresh. (optional, default to false) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -187,8 +193,8 @@ private okhttp3.Call refreshItemValidateBeforeCall(UUID itemId, MetadataRefreshM
403 Forbidden -
*/ - public void refreshItem(UUID itemId, MetadataRefreshMode metadataRefreshMode, MetadataRefreshMode imageRefreshMode, Boolean replaceAllMetadata, Boolean replaceAllImages) throws ApiException { - refreshItemWithHttpInfo(itemId, metadataRefreshMode, imageRefreshMode, replaceAllMetadata, replaceAllImages); + public void refreshItem(UUID itemId, MetadataRefreshMode metadataRefreshMode, MetadataRefreshMode imageRefreshMode, Boolean replaceAllMetadata, Boolean replaceAllImages, Boolean regenerateTrickplay) throws ApiException { + refreshItemWithHttpInfo(itemId, metadataRefreshMode, imageRefreshMode, replaceAllMetadata, replaceAllImages, regenerateTrickplay); } /** @@ -199,6 +205,7 @@ public void refreshItem(UUID itemId, MetadataRefreshMode metadataRefreshMode, Me * @param imageRefreshMode (Optional) Specifies the image refresh mode. (optional, default to None) * @param replaceAllMetadata (Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh. (optional, default to false) * @param replaceAllImages (Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh. (optional, default to false) + * @param regenerateTrickplay (Optional) Determines if trickplay images should be replaced. Only applicable if mode is FullRefresh. (optional, default to false) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -211,8 +218,8 @@ public void refreshItem(UUID itemId, MetadataRefreshMode metadataRefreshMode, Me 403 Forbidden - */ - public ApiResponse refreshItemWithHttpInfo(UUID itemId, MetadataRefreshMode metadataRefreshMode, MetadataRefreshMode imageRefreshMode, Boolean replaceAllMetadata, Boolean replaceAllImages) throws ApiException { - okhttp3.Call localVarCall = refreshItemValidateBeforeCall(itemId, metadataRefreshMode, imageRefreshMode, replaceAllMetadata, replaceAllImages, null); + public ApiResponse refreshItemWithHttpInfo(UUID itemId, MetadataRefreshMode metadataRefreshMode, MetadataRefreshMode imageRefreshMode, Boolean replaceAllMetadata, Boolean replaceAllImages, Boolean regenerateTrickplay) throws ApiException { + okhttp3.Call localVarCall = refreshItemValidateBeforeCall(itemId, metadataRefreshMode, imageRefreshMode, replaceAllMetadata, replaceAllImages, regenerateTrickplay, null); return localVarApiClient.execute(localVarCall); } @@ -224,6 +231,7 @@ public ApiResponse refreshItemWithHttpInfo(UUID itemId, MetadataRefreshMod * @param imageRefreshMode (Optional) Specifies the image refresh mode. (optional, default to None) * @param replaceAllMetadata (Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh. (optional, default to false) * @param replaceAllImages (Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh. (optional, default to false) + * @param regenerateTrickplay (Optional) Determines if trickplay images should be replaced. Only applicable if mode is FullRefresh. (optional, default to false) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -237,9 +245,9 @@ public ApiResponse refreshItemWithHttpInfo(UUID itemId, MetadataRefreshMod 403 Forbidden - */ - public okhttp3.Call refreshItemAsync(UUID itemId, MetadataRefreshMode metadataRefreshMode, MetadataRefreshMode imageRefreshMode, Boolean replaceAllMetadata, Boolean replaceAllImages, final ApiCallback _callback) throws ApiException { + public okhttp3.Call refreshItemAsync(UUID itemId, MetadataRefreshMode metadataRefreshMode, MetadataRefreshMode imageRefreshMode, Boolean replaceAllMetadata, Boolean replaceAllImages, Boolean regenerateTrickplay, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = refreshItemValidateBeforeCall(itemId, metadataRefreshMode, imageRefreshMode, replaceAllMetadata, replaceAllImages, _callback); + okhttp3.Call localVarCall = refreshItemValidateBeforeCall(itemId, metadataRefreshMode, imageRefreshMode, replaceAllMetadata, replaceAllImages, regenerateTrickplay, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ItemUpdateApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ItemUpdateApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ItemUpdateApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ItemUpdateApi.java index bd785561f0921..486d46020a0d7 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ItemUpdateApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ItemUpdateApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ItemsApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ItemsApi.java new file mode 100644 index 0000000000000..313a71338a0cf --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ItemsApi.java @@ -0,0 +1,1462 @@ +/* + * Jellyfin API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 10.10.3 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package org.openapitools.client.api; + +import org.openapitools.client.ApiCallback; +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.ApiResponse; +import org.openapitools.client.Configuration; +import org.openapitools.client.Pair; +import org.openapitools.client.ProgressRequestBody; +import org.openapitools.client.ProgressResponseBody; + +import com.google.gson.reflect.TypeToken; + +import java.io.IOException; + + +import org.openapitools.client.model.BaseItemDtoQueryResult; +import org.openapitools.client.model.BaseItemKind; +import org.openapitools.client.model.ImageType; +import org.openapitools.client.model.ItemFields; +import org.openapitools.client.model.ItemFilter; +import org.openapitools.client.model.ItemSortBy; +import org.openapitools.client.model.LocationType; +import org.openapitools.client.model.MediaType; +import java.time.OffsetDateTime; +import org.openapitools.client.model.ProblemDetails; +import org.openapitools.client.model.SeriesStatus; +import org.openapitools.client.model.SortOrder; +import java.util.UUID; +import org.openapitools.client.model.UpdateUserItemDataDto; +import org.openapitools.client.model.UserItemDataDto; +import org.openapitools.client.model.VideoType; + +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class ItemsApi { + private ApiClient localVarApiClient; + private int localHostIndex; + private String localCustomBaseUrl; + + public ItemsApi() { + this(Configuration.getDefaultApiClient()); + } + + public ItemsApi(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + public ApiClient getApiClient() { + return localVarApiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + public int getHostIndex() { + return localHostIndex; + } + + public void setHostIndex(int hostIndex) { + this.localHostIndex = hostIndex; + } + + public String getCustomBaseUrl() { + return localCustomBaseUrl; + } + + public void setCustomBaseUrl(String customBaseUrl) { + this.localCustomBaseUrl = customBaseUrl; + } + + /** + * Build call for getItemUserData + * @param itemId The item id. (required) + * @param userId The user id. (optional) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 return item user data. -
404 Item is not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getItemUserDataCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/UserItems/{itemId}/UserData" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getItemUserDataValidateBeforeCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling getItemUserData(Async)"); + } + + return getItemUserDataCall(itemId, userId, _callback); + + } + + /** + * Get Item User Data. + * + * @param itemId The item id. (required) + * @param userId The user id. (optional) + * @return UserItemDataDto + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 return item user data. -
404 Item is not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public UserItemDataDto getItemUserData(UUID itemId, UUID userId) throws ApiException { + ApiResponse localVarResp = getItemUserDataWithHttpInfo(itemId, userId); + return localVarResp.getData(); + } + + /** + * Get Item User Data. + * + * @param itemId The item id. (required) + * @param userId The user id. (optional) + * @return ApiResponse<UserItemDataDto> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 return item user data. -
404 Item is not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public ApiResponse getItemUserDataWithHttpInfo(UUID itemId, UUID userId) throws ApiException { + okhttp3.Call localVarCall = getItemUserDataValidateBeforeCall(itemId, userId, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Get Item User Data. (asynchronously) + * + * @param itemId The item id. (required) + * @param userId The user id. (optional) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 return item user data. -
404 Item is not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getItemUserDataAsync(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getItemUserDataValidateBeforeCall(itemId, userId, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for getItems + * @param userId The user id supplied as query parameter; this is required when not using an API key. (optional) + * @param maxOfficialRating Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). (optional) + * @param hasThemeSong Optional filter by items with theme songs. (optional) + * @param hasThemeVideo Optional filter by items with theme videos. (optional) + * @param hasSubtitles Optional filter by items with subtitles. (optional) + * @param hasSpecialFeature Optional filter by items with special features. (optional) + * @param hasTrailer Optional filter by items with trailers. (optional) + * @param adjacentTo Optional. Return items that are siblings of a supplied item. (optional) + * @param indexNumber Optional filter by index number. (optional) + * @param parentIndexNumber Optional filter by parent index number. (optional) + * @param hasParentalRating Optional filter by items that have or do not have a parental rating. (optional) + * @param isHd Optional filter by items that are HD or not. (optional) + * @param is4K Optional filter by items that are 4K or not. (optional) + * @param locationTypes Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited. (optional) + * @param excludeLocationTypes Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited. (optional) + * @param isMissing Optional filter by items that are missing episodes or not. (optional) + * @param isUnaired Optional filter by items that are unaired episodes or not. (optional) + * @param minCommunityRating Optional filter by minimum community rating. (optional) + * @param minCriticRating Optional filter by minimum critic rating. (optional) + * @param minPremiereDate Optional. The minimum premiere date. Format = ISO. (optional) + * @param minDateLastSaved Optional. The minimum last saved date. Format = ISO. (optional) + * @param minDateLastSavedForUser Optional. The minimum last saved date for the current user. Format = ISO. (optional) + * @param maxPremiereDate Optional. The maximum premiere date. Format = ISO. (optional) + * @param hasOverview Optional filter by items that have an overview or not. (optional) + * @param hasImdbId Optional filter by items that have an IMDb id or not. (optional) + * @param hasTmdbId Optional filter by items that have a TMDb id or not. (optional) + * @param hasTvdbId Optional filter by items that have a TVDb id or not. (optional) + * @param isMovie Optional filter for live tv movies. (optional) + * @param isSeries Optional filter for live tv series. (optional) + * @param isNews Optional filter for live tv news. (optional) + * @param isKids Optional filter for live tv kids. (optional) + * @param isSports Optional filter for live tv sports. (optional) + * @param excludeItemIds Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited. (optional) + * @param startIndex Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional) + * @param limit Optional. The maximum number of records to return. (optional) + * @param recursive When searching within folders, this determines whether or not the search will be recursive. true/false. (optional) + * @param searchTerm Optional. Filter based on a search term. (optional) + * @param sortOrder Sort Order - Ascending, Descending. (optional) + * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. (optional) + * @param fields 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. (optional) + * @param excludeItemTypes Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional) + * @param includeItemTypes Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. (optional) + * @param filters Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. (optional) + * @param isFavorite Optional filter by items that are marked as favorite, or not. (optional) + * @param mediaTypes Optional filter by MediaType. Allows multiple, comma delimited. (optional) + * @param imageTypes Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. (optional) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param isPlayed Optional filter by items that are played, or not. (optional) + * @param genres Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. (optional) + * @param officialRatings Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. (optional) + * @param tags Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. (optional) + * @param years Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. (optional) + * @param enableUserData Optional, include user data. (optional) + * @param imageTypeLimit Optional, the max number of images to return, per image type. (optional) + * @param enableImageTypes Optional. The image types to include in the output. (optional) + * @param person Optional. If specified, results will be filtered to include only those containing the specified person. (optional) + * @param personIds Optional. If specified, results will be filtered to include only those containing the specified person id. (optional) + * @param personTypes Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. (optional) + * @param studios Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. (optional) + * @param artists Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited. (optional) + * @param excludeArtistIds Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited. (optional) + * @param artistIds Optional. If specified, results will be filtered to include only those containing the specified artist id. (optional) + * @param albumArtistIds Optional. If specified, results will be filtered to include only those containing the specified album artist id. (optional) + * @param contributingArtistIds Optional. If specified, results will be filtered to include only those containing the specified contributing artist id. (optional) + * @param albums Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited. (optional) + * @param albumIds Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited. (optional) + * @param ids Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited. (optional) + * @param videoTypes Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited. (optional) + * @param minOfficialRating Optional filter by minimum official rating (PG, PG-13, TV-MA, etc). (optional) + * @param isLocked Optional filter by items that are locked. (optional) + * @param isPlaceHolder Optional filter by items that are placeholders. (optional) + * @param hasOfficialRating Optional filter by items that have official ratings. (optional) + * @param collapseBoxSetItems Whether or not to hide items behind their boxsets. (optional) + * @param minWidth Optional. Filter by the minimum width of the item. (optional) + * @param minHeight Optional. Filter by the minimum height of the item. (optional) + * @param maxWidth Optional. Filter by the maximum width of the item. (optional) + * @param maxHeight Optional. Filter by the maximum height of the item. (optional) + * @param is3D Optional filter by items that are 3D, or not. (optional) + * @param seriesStatus Optional filter by Series Status. Allows multiple, comma delimited. (optional) + * @param nameStartsWithOrGreater Optional filter by items whose name is sorted equally or greater than a given input string. (optional) + * @param nameStartsWith Optional filter by items whose name is sorted equally than a given input string. (optional) + * @param nameLessThan Optional filter by items whose name is equally or lesser than a given input string. (optional) + * @param studioIds Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. (optional) + * @param genreIds Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. (optional) + * @param enableTotalRecordCount Optional. Enable the total record count. (optional, default to true) + * @param enableImages Optional, include image information in output. (optional, default to true) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + +
Response Details
Status Code Description Response Headers
200 Success -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getItemsCall(UUID userId, String maxOfficialRating, Boolean hasThemeSong, Boolean hasThemeVideo, Boolean hasSubtitles, Boolean hasSpecialFeature, Boolean hasTrailer, UUID adjacentTo, Integer indexNumber, Integer parentIndexNumber, Boolean hasParentalRating, Boolean isHd, Boolean is4K, List locationTypes, List excludeLocationTypes, Boolean isMissing, Boolean isUnaired, Double minCommunityRating, Double minCriticRating, OffsetDateTime minPremiereDate, OffsetDateTime minDateLastSaved, OffsetDateTime minDateLastSavedForUser, OffsetDateTime maxPremiereDate, Boolean hasOverview, Boolean hasImdbId, Boolean hasTmdbId, Boolean hasTvdbId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, List excludeItemIds, Integer startIndex, Integer limit, Boolean recursive, String searchTerm, List sortOrder, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List imageTypes, List sortBy, Boolean isPlayed, List genres, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List artists, List excludeArtistIds, List artistIds, List albumArtistIds, List contributingArtistIds, List albums, List albumIds, List ids, List videoTypes, String minOfficialRating, Boolean isLocked, Boolean isPlaceHolder, Boolean hasOfficialRating, Boolean collapseBoxSetItems, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight, Boolean is3D, List seriesStatus, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List studioIds, List genreIds, Boolean enableTotalRecordCount, Boolean enableImages, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Items"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + + if (maxOfficialRating != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxOfficialRating", maxOfficialRating)); + } + + if (hasThemeSong != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("hasThemeSong", hasThemeSong)); + } + + if (hasThemeVideo != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("hasThemeVideo", hasThemeVideo)); + } + + if (hasSubtitles != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("hasSubtitles", hasSubtitles)); + } + + if (hasSpecialFeature != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("hasSpecialFeature", hasSpecialFeature)); + } + + if (hasTrailer != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("hasTrailer", hasTrailer)); + } + + if (adjacentTo != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("adjacentTo", adjacentTo)); + } + + if (indexNumber != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("indexNumber", indexNumber)); + } + + if (parentIndexNumber != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("parentIndexNumber", parentIndexNumber)); + } + + if (hasParentalRating != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("hasParentalRating", hasParentalRating)); + } + + if (isHd != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("isHd", isHd)); + } + + if (is4K != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("is4K", is4K)); + } + + if (locationTypes != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "locationTypes", locationTypes)); + } + + if (excludeLocationTypes != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "excludeLocationTypes", excludeLocationTypes)); + } + + if (isMissing != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("isMissing", isMissing)); + } + + if (isUnaired != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("isUnaired", isUnaired)); + } + + if (minCommunityRating != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("minCommunityRating", minCommunityRating)); + } + + if (minCriticRating != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("minCriticRating", minCriticRating)); + } + + if (minPremiereDate != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("minPremiereDate", minPremiereDate)); + } + + if (minDateLastSaved != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("minDateLastSaved", minDateLastSaved)); + } + + if (minDateLastSavedForUser != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("minDateLastSavedForUser", minDateLastSavedForUser)); + } + + if (maxPremiereDate != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxPremiereDate", maxPremiereDate)); + } + + if (hasOverview != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("hasOverview", hasOverview)); + } + + if (hasImdbId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("hasImdbId", hasImdbId)); + } + + if (hasTmdbId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("hasTmdbId", hasTmdbId)); + } + + if (hasTvdbId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("hasTvdbId", hasTvdbId)); + } + + if (isMovie != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("isMovie", isMovie)); + } + + if (isSeries != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("isSeries", isSeries)); + } + + if (isNews != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("isNews", isNews)); + } + + if (isKids != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("isKids", isKids)); + } + + if (isSports != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("isSports", isSports)); + } + + if (excludeItemIds != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "excludeItemIds", excludeItemIds)); + } + + if (startIndex != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("startIndex", startIndex)); + } + + if (limit != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); + } + + if (recursive != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("recursive", recursive)); + } + + if (searchTerm != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("searchTerm", searchTerm)); + } + + if (sortOrder != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "sortOrder", sortOrder)); + } + + if (parentId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("parentId", parentId)); + } + + if (fields != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "fields", fields)); + } + + if (excludeItemTypes != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "excludeItemTypes", excludeItemTypes)); + } + + if (includeItemTypes != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "includeItemTypes", includeItemTypes)); + } + + if (filters != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "filters", filters)); + } + + if (isFavorite != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("isFavorite", isFavorite)); + } + + if (mediaTypes != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "mediaTypes", mediaTypes)); + } + + if (imageTypes != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "imageTypes", imageTypes)); + } + + if (sortBy != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "sortBy", sortBy)); + } + + if (isPlayed != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("isPlayed", isPlayed)); + } + + if (genres != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "genres", genres)); + } + + if (officialRatings != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "officialRatings", officialRatings)); + } + + if (tags != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "tags", tags)); + } + + if (years != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "years", years)); + } + + if (enableUserData != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableUserData", enableUserData)); + } + + if (imageTypeLimit != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("imageTypeLimit", imageTypeLimit)); + } + + if (enableImageTypes != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "enableImageTypes", enableImageTypes)); + } + + if (person != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("person", person)); + } + + if (personIds != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "personIds", personIds)); + } + + if (personTypes != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "personTypes", personTypes)); + } + + if (studios != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "studios", studios)); + } + + if (artists != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "artists", artists)); + } + + if (excludeArtistIds != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "excludeArtistIds", excludeArtistIds)); + } + + if (artistIds != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "artistIds", artistIds)); + } + + if (albumArtistIds != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "albumArtistIds", albumArtistIds)); + } + + if (contributingArtistIds != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "contributingArtistIds", contributingArtistIds)); + } + + if (albums != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "albums", albums)); + } + + if (albumIds != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "albumIds", albumIds)); + } + + if (ids != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "ids", ids)); + } + + if (videoTypes != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "videoTypes", videoTypes)); + } + + if (minOfficialRating != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("minOfficialRating", minOfficialRating)); + } + + if (isLocked != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("isLocked", isLocked)); + } + + if (isPlaceHolder != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("isPlaceHolder", isPlaceHolder)); + } + + if (hasOfficialRating != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("hasOfficialRating", hasOfficialRating)); + } + + if (collapseBoxSetItems != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("collapseBoxSetItems", collapseBoxSetItems)); + } + + if (minWidth != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("minWidth", minWidth)); + } + + if (minHeight != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("minHeight", minHeight)); + } + + if (maxWidth != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxWidth", maxWidth)); + } + + if (maxHeight != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxHeight", maxHeight)); + } + + if (is3D != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("is3D", is3D)); + } + + if (seriesStatus != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "seriesStatus", seriesStatus)); + } + + if (nameStartsWithOrGreater != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("nameStartsWithOrGreater", nameStartsWithOrGreater)); + } + + if (nameStartsWith != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("nameStartsWith", nameStartsWith)); + } + + if (nameLessThan != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("nameLessThan", nameLessThan)); + } + + if (studioIds != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "studioIds", studioIds)); + } + + if (genreIds != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "genreIds", genreIds)); + } + + if (enableTotalRecordCount != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableTotalRecordCount", enableTotalRecordCount)); + } + + if (enableImages != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableImages", enableImages)); + } + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getItemsValidateBeforeCall(UUID userId, String maxOfficialRating, Boolean hasThemeSong, Boolean hasThemeVideo, Boolean hasSubtitles, Boolean hasSpecialFeature, Boolean hasTrailer, UUID adjacentTo, Integer indexNumber, Integer parentIndexNumber, Boolean hasParentalRating, Boolean isHd, Boolean is4K, List locationTypes, List excludeLocationTypes, Boolean isMissing, Boolean isUnaired, Double minCommunityRating, Double minCriticRating, OffsetDateTime minPremiereDate, OffsetDateTime minDateLastSaved, OffsetDateTime minDateLastSavedForUser, OffsetDateTime maxPremiereDate, Boolean hasOverview, Boolean hasImdbId, Boolean hasTmdbId, Boolean hasTvdbId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, List excludeItemIds, Integer startIndex, Integer limit, Boolean recursive, String searchTerm, List sortOrder, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List imageTypes, List sortBy, Boolean isPlayed, List genres, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List artists, List excludeArtistIds, List artistIds, List albumArtistIds, List contributingArtistIds, List albums, List albumIds, List ids, List videoTypes, String minOfficialRating, Boolean isLocked, Boolean isPlaceHolder, Boolean hasOfficialRating, Boolean collapseBoxSetItems, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight, Boolean is3D, List seriesStatus, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List studioIds, List genreIds, Boolean enableTotalRecordCount, Boolean enableImages, final ApiCallback _callback) throws ApiException { + return getItemsCall(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, indexNumber, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, _callback); + + } + + /** + * Gets items based on a query. + * + * @param userId The user id supplied as query parameter; this is required when not using an API key. (optional) + * @param maxOfficialRating Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). (optional) + * @param hasThemeSong Optional filter by items with theme songs. (optional) + * @param hasThemeVideo Optional filter by items with theme videos. (optional) + * @param hasSubtitles Optional filter by items with subtitles. (optional) + * @param hasSpecialFeature Optional filter by items with special features. (optional) + * @param hasTrailer Optional filter by items with trailers. (optional) + * @param adjacentTo Optional. Return items that are siblings of a supplied item. (optional) + * @param indexNumber Optional filter by index number. (optional) + * @param parentIndexNumber Optional filter by parent index number. (optional) + * @param hasParentalRating Optional filter by items that have or do not have a parental rating. (optional) + * @param isHd Optional filter by items that are HD or not. (optional) + * @param is4K Optional filter by items that are 4K or not. (optional) + * @param locationTypes Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited. (optional) + * @param excludeLocationTypes Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited. (optional) + * @param isMissing Optional filter by items that are missing episodes or not. (optional) + * @param isUnaired Optional filter by items that are unaired episodes or not. (optional) + * @param minCommunityRating Optional filter by minimum community rating. (optional) + * @param minCriticRating Optional filter by minimum critic rating. (optional) + * @param minPremiereDate Optional. The minimum premiere date. Format = ISO. (optional) + * @param minDateLastSaved Optional. The minimum last saved date. Format = ISO. (optional) + * @param minDateLastSavedForUser Optional. The minimum last saved date for the current user. Format = ISO. (optional) + * @param maxPremiereDate Optional. The maximum premiere date. Format = ISO. (optional) + * @param hasOverview Optional filter by items that have an overview or not. (optional) + * @param hasImdbId Optional filter by items that have an IMDb id or not. (optional) + * @param hasTmdbId Optional filter by items that have a TMDb id or not. (optional) + * @param hasTvdbId Optional filter by items that have a TVDb id or not. (optional) + * @param isMovie Optional filter for live tv movies. (optional) + * @param isSeries Optional filter for live tv series. (optional) + * @param isNews Optional filter for live tv news. (optional) + * @param isKids Optional filter for live tv kids. (optional) + * @param isSports Optional filter for live tv sports. (optional) + * @param excludeItemIds Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited. (optional) + * @param startIndex Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional) + * @param limit Optional. The maximum number of records to return. (optional) + * @param recursive When searching within folders, this determines whether or not the search will be recursive. true/false. (optional) + * @param searchTerm Optional. Filter based on a search term. (optional) + * @param sortOrder Sort Order - Ascending, Descending. (optional) + * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. (optional) + * @param fields 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. (optional) + * @param excludeItemTypes Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional) + * @param includeItemTypes Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. (optional) + * @param filters Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. (optional) + * @param isFavorite Optional filter by items that are marked as favorite, or not. (optional) + * @param mediaTypes Optional filter by MediaType. Allows multiple, comma delimited. (optional) + * @param imageTypes Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. (optional) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param isPlayed Optional filter by items that are played, or not. (optional) + * @param genres Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. (optional) + * @param officialRatings Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. (optional) + * @param tags Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. (optional) + * @param years Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. (optional) + * @param enableUserData Optional, include user data. (optional) + * @param imageTypeLimit Optional, the max number of images to return, per image type. (optional) + * @param enableImageTypes Optional. The image types to include in the output. (optional) + * @param person Optional. If specified, results will be filtered to include only those containing the specified person. (optional) + * @param personIds Optional. If specified, results will be filtered to include only those containing the specified person id. (optional) + * @param personTypes Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. (optional) + * @param studios Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. (optional) + * @param artists Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited. (optional) + * @param excludeArtistIds Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited. (optional) + * @param artistIds Optional. If specified, results will be filtered to include only those containing the specified artist id. (optional) + * @param albumArtistIds Optional. If specified, results will be filtered to include only those containing the specified album artist id. (optional) + * @param contributingArtistIds Optional. If specified, results will be filtered to include only those containing the specified contributing artist id. (optional) + * @param albums Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited. (optional) + * @param albumIds Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited. (optional) + * @param ids Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited. (optional) + * @param videoTypes Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited. (optional) + * @param minOfficialRating Optional filter by minimum official rating (PG, PG-13, TV-MA, etc). (optional) + * @param isLocked Optional filter by items that are locked. (optional) + * @param isPlaceHolder Optional filter by items that are placeholders. (optional) + * @param hasOfficialRating Optional filter by items that have official ratings. (optional) + * @param collapseBoxSetItems Whether or not to hide items behind their boxsets. (optional) + * @param minWidth Optional. Filter by the minimum width of the item. (optional) + * @param minHeight Optional. Filter by the minimum height of the item. (optional) + * @param maxWidth Optional. Filter by the maximum width of the item. (optional) + * @param maxHeight Optional. Filter by the maximum height of the item. (optional) + * @param is3D Optional filter by items that are 3D, or not. (optional) + * @param seriesStatus Optional filter by Series Status. Allows multiple, comma delimited. (optional) + * @param nameStartsWithOrGreater Optional filter by items whose name is sorted equally or greater than a given input string. (optional) + * @param nameStartsWith Optional filter by items whose name is sorted equally than a given input string. (optional) + * @param nameLessThan Optional filter by items whose name is equally or lesser than a given input string. (optional) + * @param studioIds Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. (optional) + * @param genreIds Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. (optional) + * @param enableTotalRecordCount Optional. Enable the total record count. (optional, default to true) + * @param enableImages Optional, include image information in output. (optional, default to true) + * @return BaseItemDtoQueryResult + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Response Details
Status Code Description Response Headers
200 Success -
401 Unauthorized -
403 Forbidden -
+ */ + public BaseItemDtoQueryResult getItems(UUID userId, String maxOfficialRating, Boolean hasThemeSong, Boolean hasThemeVideo, Boolean hasSubtitles, Boolean hasSpecialFeature, Boolean hasTrailer, UUID adjacentTo, Integer indexNumber, Integer parentIndexNumber, Boolean hasParentalRating, Boolean isHd, Boolean is4K, List locationTypes, List excludeLocationTypes, Boolean isMissing, Boolean isUnaired, Double minCommunityRating, Double minCriticRating, OffsetDateTime minPremiereDate, OffsetDateTime minDateLastSaved, OffsetDateTime minDateLastSavedForUser, OffsetDateTime maxPremiereDate, Boolean hasOverview, Boolean hasImdbId, Boolean hasTmdbId, Boolean hasTvdbId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, List excludeItemIds, Integer startIndex, Integer limit, Boolean recursive, String searchTerm, List sortOrder, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List imageTypes, List sortBy, Boolean isPlayed, List genres, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List artists, List excludeArtistIds, List artistIds, List albumArtistIds, List contributingArtistIds, List albums, List albumIds, List ids, List videoTypes, String minOfficialRating, Boolean isLocked, Boolean isPlaceHolder, Boolean hasOfficialRating, Boolean collapseBoxSetItems, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight, Boolean is3D, List seriesStatus, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List studioIds, List genreIds, Boolean enableTotalRecordCount, Boolean enableImages) throws ApiException { + ApiResponse localVarResp = getItemsWithHttpInfo(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, indexNumber, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages); + return localVarResp.getData(); + } + + /** + * Gets items based on a query. + * + * @param userId The user id supplied as query parameter; this is required when not using an API key. (optional) + * @param maxOfficialRating Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). (optional) + * @param hasThemeSong Optional filter by items with theme songs. (optional) + * @param hasThemeVideo Optional filter by items with theme videos. (optional) + * @param hasSubtitles Optional filter by items with subtitles. (optional) + * @param hasSpecialFeature Optional filter by items with special features. (optional) + * @param hasTrailer Optional filter by items with trailers. (optional) + * @param adjacentTo Optional. Return items that are siblings of a supplied item. (optional) + * @param indexNumber Optional filter by index number. (optional) + * @param parentIndexNumber Optional filter by parent index number. (optional) + * @param hasParentalRating Optional filter by items that have or do not have a parental rating. (optional) + * @param isHd Optional filter by items that are HD or not. (optional) + * @param is4K Optional filter by items that are 4K or not. (optional) + * @param locationTypes Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited. (optional) + * @param excludeLocationTypes Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited. (optional) + * @param isMissing Optional filter by items that are missing episodes or not. (optional) + * @param isUnaired Optional filter by items that are unaired episodes or not. (optional) + * @param minCommunityRating Optional filter by minimum community rating. (optional) + * @param minCriticRating Optional filter by minimum critic rating. (optional) + * @param minPremiereDate Optional. The minimum premiere date. Format = ISO. (optional) + * @param minDateLastSaved Optional. The minimum last saved date. Format = ISO. (optional) + * @param minDateLastSavedForUser Optional. The minimum last saved date for the current user. Format = ISO. (optional) + * @param maxPremiereDate Optional. The maximum premiere date. Format = ISO. (optional) + * @param hasOverview Optional filter by items that have an overview or not. (optional) + * @param hasImdbId Optional filter by items that have an IMDb id or not. (optional) + * @param hasTmdbId Optional filter by items that have a TMDb id or not. (optional) + * @param hasTvdbId Optional filter by items that have a TVDb id or not. (optional) + * @param isMovie Optional filter for live tv movies. (optional) + * @param isSeries Optional filter for live tv series. (optional) + * @param isNews Optional filter for live tv news. (optional) + * @param isKids Optional filter for live tv kids. (optional) + * @param isSports Optional filter for live tv sports. (optional) + * @param excludeItemIds Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited. (optional) + * @param startIndex Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional) + * @param limit Optional. The maximum number of records to return. (optional) + * @param recursive When searching within folders, this determines whether or not the search will be recursive. true/false. (optional) + * @param searchTerm Optional. Filter based on a search term. (optional) + * @param sortOrder Sort Order - Ascending, Descending. (optional) + * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. (optional) + * @param fields 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. (optional) + * @param excludeItemTypes Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional) + * @param includeItemTypes Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. (optional) + * @param filters Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. (optional) + * @param isFavorite Optional filter by items that are marked as favorite, or not. (optional) + * @param mediaTypes Optional filter by MediaType. Allows multiple, comma delimited. (optional) + * @param imageTypes Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. (optional) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param isPlayed Optional filter by items that are played, or not. (optional) + * @param genres Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. (optional) + * @param officialRatings Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. (optional) + * @param tags Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. (optional) + * @param years Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. (optional) + * @param enableUserData Optional, include user data. (optional) + * @param imageTypeLimit Optional, the max number of images to return, per image type. (optional) + * @param enableImageTypes Optional. The image types to include in the output. (optional) + * @param person Optional. If specified, results will be filtered to include only those containing the specified person. (optional) + * @param personIds Optional. If specified, results will be filtered to include only those containing the specified person id. (optional) + * @param personTypes Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. (optional) + * @param studios Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. (optional) + * @param artists Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited. (optional) + * @param excludeArtistIds Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited. (optional) + * @param artistIds Optional. If specified, results will be filtered to include only those containing the specified artist id. (optional) + * @param albumArtistIds Optional. If specified, results will be filtered to include only those containing the specified album artist id. (optional) + * @param contributingArtistIds Optional. If specified, results will be filtered to include only those containing the specified contributing artist id. (optional) + * @param albums Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited. (optional) + * @param albumIds Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited. (optional) + * @param ids Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited. (optional) + * @param videoTypes Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited. (optional) + * @param minOfficialRating Optional filter by minimum official rating (PG, PG-13, TV-MA, etc). (optional) + * @param isLocked Optional filter by items that are locked. (optional) + * @param isPlaceHolder Optional filter by items that are placeholders. (optional) + * @param hasOfficialRating Optional filter by items that have official ratings. (optional) + * @param collapseBoxSetItems Whether or not to hide items behind their boxsets. (optional) + * @param minWidth Optional. Filter by the minimum width of the item. (optional) + * @param minHeight Optional. Filter by the minimum height of the item. (optional) + * @param maxWidth Optional. Filter by the maximum width of the item. (optional) + * @param maxHeight Optional. Filter by the maximum height of the item. (optional) + * @param is3D Optional filter by items that are 3D, or not. (optional) + * @param seriesStatus Optional filter by Series Status. Allows multiple, comma delimited. (optional) + * @param nameStartsWithOrGreater Optional filter by items whose name is sorted equally or greater than a given input string. (optional) + * @param nameStartsWith Optional filter by items whose name is sorted equally than a given input string. (optional) + * @param nameLessThan Optional filter by items whose name is equally or lesser than a given input string. (optional) + * @param studioIds Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. (optional) + * @param genreIds Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. (optional) + * @param enableTotalRecordCount Optional. Enable the total record count. (optional, default to true) + * @param enableImages Optional, include image information in output. (optional, default to true) + * @return ApiResponse<BaseItemDtoQueryResult> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Response Details
Status Code Description Response Headers
200 Success -
401 Unauthorized -
403 Forbidden -
+ */ + public ApiResponse getItemsWithHttpInfo(UUID userId, String maxOfficialRating, Boolean hasThemeSong, Boolean hasThemeVideo, Boolean hasSubtitles, Boolean hasSpecialFeature, Boolean hasTrailer, UUID adjacentTo, Integer indexNumber, Integer parentIndexNumber, Boolean hasParentalRating, Boolean isHd, Boolean is4K, List locationTypes, List excludeLocationTypes, Boolean isMissing, Boolean isUnaired, Double minCommunityRating, Double minCriticRating, OffsetDateTime minPremiereDate, OffsetDateTime minDateLastSaved, OffsetDateTime minDateLastSavedForUser, OffsetDateTime maxPremiereDate, Boolean hasOverview, Boolean hasImdbId, Boolean hasTmdbId, Boolean hasTvdbId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, List excludeItemIds, Integer startIndex, Integer limit, Boolean recursive, String searchTerm, List sortOrder, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List imageTypes, List sortBy, Boolean isPlayed, List genres, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List artists, List excludeArtistIds, List artistIds, List albumArtistIds, List contributingArtistIds, List albums, List albumIds, List ids, List videoTypes, String minOfficialRating, Boolean isLocked, Boolean isPlaceHolder, Boolean hasOfficialRating, Boolean collapseBoxSetItems, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight, Boolean is3D, List seriesStatus, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List studioIds, List genreIds, Boolean enableTotalRecordCount, Boolean enableImages) throws ApiException { + okhttp3.Call localVarCall = getItemsValidateBeforeCall(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, indexNumber, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Gets items based on a query. (asynchronously) + * + * @param userId The user id supplied as query parameter; this is required when not using an API key. (optional) + * @param maxOfficialRating Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). (optional) + * @param hasThemeSong Optional filter by items with theme songs. (optional) + * @param hasThemeVideo Optional filter by items with theme videos. (optional) + * @param hasSubtitles Optional filter by items with subtitles. (optional) + * @param hasSpecialFeature Optional filter by items with special features. (optional) + * @param hasTrailer Optional filter by items with trailers. (optional) + * @param adjacentTo Optional. Return items that are siblings of a supplied item. (optional) + * @param indexNumber Optional filter by index number. (optional) + * @param parentIndexNumber Optional filter by parent index number. (optional) + * @param hasParentalRating Optional filter by items that have or do not have a parental rating. (optional) + * @param isHd Optional filter by items that are HD or not. (optional) + * @param is4K Optional filter by items that are 4K or not. (optional) + * @param locationTypes Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited. (optional) + * @param excludeLocationTypes Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited. (optional) + * @param isMissing Optional filter by items that are missing episodes or not. (optional) + * @param isUnaired Optional filter by items that are unaired episodes or not. (optional) + * @param minCommunityRating Optional filter by minimum community rating. (optional) + * @param minCriticRating Optional filter by minimum critic rating. (optional) + * @param minPremiereDate Optional. The minimum premiere date. Format = ISO. (optional) + * @param minDateLastSaved Optional. The minimum last saved date. Format = ISO. (optional) + * @param minDateLastSavedForUser Optional. The minimum last saved date for the current user. Format = ISO. (optional) + * @param maxPremiereDate Optional. The maximum premiere date. Format = ISO. (optional) + * @param hasOverview Optional filter by items that have an overview or not. (optional) + * @param hasImdbId Optional filter by items that have an IMDb id or not. (optional) + * @param hasTmdbId Optional filter by items that have a TMDb id or not. (optional) + * @param hasTvdbId Optional filter by items that have a TVDb id or not. (optional) + * @param isMovie Optional filter for live tv movies. (optional) + * @param isSeries Optional filter for live tv series. (optional) + * @param isNews Optional filter for live tv news. (optional) + * @param isKids Optional filter for live tv kids. (optional) + * @param isSports Optional filter for live tv sports. (optional) + * @param excludeItemIds Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited. (optional) + * @param startIndex Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional) + * @param limit Optional. The maximum number of records to return. (optional) + * @param recursive When searching within folders, this determines whether or not the search will be recursive. true/false. (optional) + * @param searchTerm Optional. Filter based on a search term. (optional) + * @param sortOrder Sort Order - Ascending, Descending. (optional) + * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. (optional) + * @param fields 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. (optional) + * @param excludeItemTypes Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional) + * @param includeItemTypes Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. (optional) + * @param filters Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. (optional) + * @param isFavorite Optional filter by items that are marked as favorite, or not. (optional) + * @param mediaTypes Optional filter by MediaType. Allows multiple, comma delimited. (optional) + * @param imageTypes Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. (optional) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param isPlayed Optional filter by items that are played, or not. (optional) + * @param genres Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. (optional) + * @param officialRatings Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. (optional) + * @param tags Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. (optional) + * @param years Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. (optional) + * @param enableUserData Optional, include user data. (optional) + * @param imageTypeLimit Optional, the max number of images to return, per image type. (optional) + * @param enableImageTypes Optional. The image types to include in the output. (optional) + * @param person Optional. If specified, results will be filtered to include only those containing the specified person. (optional) + * @param personIds Optional. If specified, results will be filtered to include only those containing the specified person id. (optional) + * @param personTypes Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. (optional) + * @param studios Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. (optional) + * @param artists Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited. (optional) + * @param excludeArtistIds Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited. (optional) + * @param artistIds Optional. If specified, results will be filtered to include only those containing the specified artist id. (optional) + * @param albumArtistIds Optional. If specified, results will be filtered to include only those containing the specified album artist id. (optional) + * @param contributingArtistIds Optional. If specified, results will be filtered to include only those containing the specified contributing artist id. (optional) + * @param albums Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited. (optional) + * @param albumIds Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited. (optional) + * @param ids Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited. (optional) + * @param videoTypes Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited. (optional) + * @param minOfficialRating Optional filter by minimum official rating (PG, PG-13, TV-MA, etc). (optional) + * @param isLocked Optional filter by items that are locked. (optional) + * @param isPlaceHolder Optional filter by items that are placeholders. (optional) + * @param hasOfficialRating Optional filter by items that have official ratings. (optional) + * @param collapseBoxSetItems Whether or not to hide items behind their boxsets. (optional) + * @param minWidth Optional. Filter by the minimum width of the item. (optional) + * @param minHeight Optional. Filter by the minimum height of the item. (optional) + * @param maxWidth Optional. Filter by the maximum width of the item. (optional) + * @param maxHeight Optional. Filter by the maximum height of the item. (optional) + * @param is3D Optional filter by items that are 3D, or not. (optional) + * @param seriesStatus Optional filter by Series Status. Allows multiple, comma delimited. (optional) + * @param nameStartsWithOrGreater Optional filter by items whose name is sorted equally or greater than a given input string. (optional) + * @param nameStartsWith Optional filter by items whose name is sorted equally than a given input string. (optional) + * @param nameLessThan Optional filter by items whose name is equally or lesser than a given input string. (optional) + * @param studioIds Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. (optional) + * @param genreIds Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. (optional) + * @param enableTotalRecordCount Optional. Enable the total record count. (optional, default to true) + * @param enableImages Optional, include image information in output. (optional, default to true) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + +
Response Details
Status Code Description Response Headers
200 Success -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getItemsAsync(UUID userId, String maxOfficialRating, Boolean hasThemeSong, Boolean hasThemeVideo, Boolean hasSubtitles, Boolean hasSpecialFeature, Boolean hasTrailer, UUID adjacentTo, Integer indexNumber, Integer parentIndexNumber, Boolean hasParentalRating, Boolean isHd, Boolean is4K, List locationTypes, List excludeLocationTypes, Boolean isMissing, Boolean isUnaired, Double minCommunityRating, Double minCriticRating, OffsetDateTime minPremiereDate, OffsetDateTime minDateLastSaved, OffsetDateTime minDateLastSavedForUser, OffsetDateTime maxPremiereDate, Boolean hasOverview, Boolean hasImdbId, Boolean hasTmdbId, Boolean hasTvdbId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, List excludeItemIds, Integer startIndex, Integer limit, Boolean recursive, String searchTerm, List sortOrder, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List imageTypes, List sortBy, Boolean isPlayed, List genres, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List artists, List excludeArtistIds, List artistIds, List albumArtistIds, List contributingArtistIds, List albums, List albumIds, List ids, List videoTypes, String minOfficialRating, Boolean isLocked, Boolean isPlaceHolder, Boolean hasOfficialRating, Boolean collapseBoxSetItems, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight, Boolean is3D, List seriesStatus, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List studioIds, List genreIds, Boolean enableTotalRecordCount, Boolean enableImages, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getItemsValidateBeforeCall(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, indexNumber, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for getResumeItems + * @param userId The user id. (optional) + * @param startIndex The start index. (optional) + * @param limit The item limit. (optional) + * @param searchTerm The search term. (optional) + * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. (optional) + * @param fields 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. (optional) + * @param mediaTypes Optional. Filter by MediaType. Allows multiple, comma delimited. (optional) + * @param enableUserData Optional. Include user data. (optional) + * @param imageTypeLimit Optional. The max number of images to return, per image type. (optional) + * @param enableImageTypes Optional. The image types to include in the output. (optional) + * @param excludeItemTypes Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional) + * @param includeItemTypes Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. (optional) + * @param enableTotalRecordCount Optional. Enable the total record count. (optional, default to true) + * @param enableImages Optional. Include image information in output. (optional, default to true) + * @param excludeActiveSessions Optional. Whether to exclude the currently active sessions. (optional, default to false) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + +
Response Details
Status Code Description Response Headers
200 Items returned. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getResumeItemsCall(UUID userId, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List mediaTypes, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, List excludeItemTypes, List includeItemTypes, Boolean enableTotalRecordCount, Boolean enableImages, Boolean excludeActiveSessions, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/UserItems/Resume"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + + if (startIndex != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("startIndex", startIndex)); + } + + if (limit != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); + } + + if (searchTerm != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("searchTerm", searchTerm)); + } + + if (parentId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("parentId", parentId)); + } + + if (fields != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "fields", fields)); + } + + if (mediaTypes != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "mediaTypes", mediaTypes)); + } + + if (enableUserData != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableUserData", enableUserData)); + } + + if (imageTypeLimit != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("imageTypeLimit", imageTypeLimit)); + } + + if (enableImageTypes != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "enableImageTypes", enableImageTypes)); + } + + if (excludeItemTypes != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "excludeItemTypes", excludeItemTypes)); + } + + if (includeItemTypes != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "includeItemTypes", includeItemTypes)); + } + + if (enableTotalRecordCount != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableTotalRecordCount", enableTotalRecordCount)); + } + + if (enableImages != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableImages", enableImages)); + } + + if (excludeActiveSessions != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("excludeActiveSessions", excludeActiveSessions)); + } + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getResumeItemsValidateBeforeCall(UUID userId, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List mediaTypes, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, List excludeItemTypes, List includeItemTypes, Boolean enableTotalRecordCount, Boolean enableImages, Boolean excludeActiveSessions, final ApiCallback _callback) throws ApiException { + return getResumeItemsCall(userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, _callback); + + } + + /** + * Gets items based on a query. + * + * @param userId The user id. (optional) + * @param startIndex The start index. (optional) + * @param limit The item limit. (optional) + * @param searchTerm The search term. (optional) + * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. (optional) + * @param fields 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. (optional) + * @param mediaTypes Optional. Filter by MediaType. Allows multiple, comma delimited. (optional) + * @param enableUserData Optional. Include user data. (optional) + * @param imageTypeLimit Optional. The max number of images to return, per image type. (optional) + * @param enableImageTypes Optional. The image types to include in the output. (optional) + * @param excludeItemTypes Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional) + * @param includeItemTypes Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. (optional) + * @param enableTotalRecordCount Optional. Enable the total record count. (optional, default to true) + * @param enableImages Optional. Include image information in output. (optional, default to true) + * @param excludeActiveSessions Optional. Whether to exclude the currently active sessions. (optional, default to false) + * @return BaseItemDtoQueryResult + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Response Details
Status Code Description Response Headers
200 Items returned. -
401 Unauthorized -
403 Forbidden -
+ */ + public BaseItemDtoQueryResult getResumeItems(UUID userId, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List mediaTypes, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, List excludeItemTypes, List includeItemTypes, Boolean enableTotalRecordCount, Boolean enableImages, Boolean excludeActiveSessions) throws ApiException { + ApiResponse localVarResp = getResumeItemsWithHttpInfo(userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions); + return localVarResp.getData(); + } + + /** + * Gets items based on a query. + * + * @param userId The user id. (optional) + * @param startIndex The start index. (optional) + * @param limit The item limit. (optional) + * @param searchTerm The search term. (optional) + * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. (optional) + * @param fields 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. (optional) + * @param mediaTypes Optional. Filter by MediaType. Allows multiple, comma delimited. (optional) + * @param enableUserData Optional. Include user data. (optional) + * @param imageTypeLimit Optional. The max number of images to return, per image type. (optional) + * @param enableImageTypes Optional. The image types to include in the output. (optional) + * @param excludeItemTypes Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional) + * @param includeItemTypes Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. (optional) + * @param enableTotalRecordCount Optional. Enable the total record count. (optional, default to true) + * @param enableImages Optional. Include image information in output. (optional, default to true) + * @param excludeActiveSessions Optional. Whether to exclude the currently active sessions. (optional, default to false) + * @return ApiResponse<BaseItemDtoQueryResult> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Response Details
Status Code Description Response Headers
200 Items returned. -
401 Unauthorized -
403 Forbidden -
+ */ + public ApiResponse getResumeItemsWithHttpInfo(UUID userId, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List mediaTypes, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, List excludeItemTypes, List includeItemTypes, Boolean enableTotalRecordCount, Boolean enableImages, Boolean excludeActiveSessions) throws ApiException { + okhttp3.Call localVarCall = getResumeItemsValidateBeforeCall(userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Gets items based on a query. (asynchronously) + * + * @param userId The user id. (optional) + * @param startIndex The start index. (optional) + * @param limit The item limit. (optional) + * @param searchTerm The search term. (optional) + * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. (optional) + * @param fields 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. (optional) + * @param mediaTypes Optional. Filter by MediaType. Allows multiple, comma delimited. (optional) + * @param enableUserData Optional. Include user data. (optional) + * @param imageTypeLimit Optional. The max number of images to return, per image type. (optional) + * @param enableImageTypes Optional. The image types to include in the output. (optional) + * @param excludeItemTypes Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional) + * @param includeItemTypes Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. (optional) + * @param enableTotalRecordCount Optional. Enable the total record count. (optional, default to true) + * @param enableImages Optional. Include image information in output. (optional, default to true) + * @param excludeActiveSessions Optional. Whether to exclude the currently active sessions. (optional, default to false) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + +
Response Details
Status Code Description Response Headers
200 Items returned. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getResumeItemsAsync(UUID userId, Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List mediaTypes, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, List excludeItemTypes, List includeItemTypes, Boolean enableTotalRecordCount, Boolean enableImages, Boolean excludeActiveSessions, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getResumeItemsValidateBeforeCall(userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for updateItemUserData + * @param itemId The item id. (required) + * @param updateUserItemDataDto New user data object. (required) + * @param userId The user id. (optional) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 return updated user item data. -
404 Item is not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call updateItemUserDataCall(UUID itemId, UpdateUserItemDataDto updateUserItemDataDto, UUID userId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = updateUserItemDataDto; + + // create path and map variables + String localVarPath = "/UserItems/{itemId}/UserData" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json", + "text/json", + "application/*+json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call updateItemUserDataValidateBeforeCall(UUID itemId, UpdateUserItemDataDto updateUserItemDataDto, UUID userId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling updateItemUserData(Async)"); + } + + // verify the required parameter 'updateUserItemDataDto' is set + if (updateUserItemDataDto == null) { + throw new ApiException("Missing the required parameter 'updateUserItemDataDto' when calling updateItemUserData(Async)"); + } + + return updateItemUserDataCall(itemId, updateUserItemDataDto, userId, _callback); + + } + + /** + * Update Item User Data. + * + * @param itemId The item id. (required) + * @param updateUserItemDataDto New user data object. (required) + * @param userId The user id. (optional) + * @return UserItemDataDto + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 return updated user item data. -
404 Item is not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public UserItemDataDto updateItemUserData(UUID itemId, UpdateUserItemDataDto updateUserItemDataDto, UUID userId) throws ApiException { + ApiResponse localVarResp = updateItemUserDataWithHttpInfo(itemId, updateUserItemDataDto, userId); + return localVarResp.getData(); + } + + /** + * Update Item User Data. + * + * @param itemId The item id. (required) + * @param updateUserItemDataDto New user data object. (required) + * @param userId The user id. (optional) + * @return ApiResponse<UserItemDataDto> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 return updated user item data. -
404 Item is not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public ApiResponse updateItemUserDataWithHttpInfo(UUID itemId, UpdateUserItemDataDto updateUserItemDataDto, UUID userId) throws ApiException { + okhttp3.Call localVarCall = updateItemUserDataValidateBeforeCall(itemId, updateUserItemDataDto, userId, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Update Item User Data. (asynchronously) + * + * @param itemId The item id. (required) + * @param updateUserItemDataDto New user data object. (required) + * @param userId The user id. (optional) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 return updated user item data. -
404 Item is not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call updateItemUserDataAsync(UUID itemId, UpdateUserItemDataDto updateUserItemDataDto, UUID userId, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = updateItemUserDataValidateBeforeCall(itemId, updateUserItemDataDto, userId, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } +} diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/LibraryApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/LibraryApi.java similarity index 95% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/LibraryApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/LibraryApi.java index b4e3aaaa4b62c..8a30040a193d4 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/LibraryApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/LibraryApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -30,12 +30,15 @@ import org.openapitools.client.model.AllThemeMediaResult; import org.openapitools.client.model.BaseItemDto; import org.openapitools.client.model.BaseItemDtoQueryResult; +import org.openapitools.client.model.CollectionType; import java.io.File; import org.openapitools.client.model.ItemCounts; import org.openapitools.client.model.ItemFields; +import org.openapitools.client.model.ItemSortBy; import org.openapitools.client.model.LibraryOptionsResultDto; import org.openapitools.client.model.MediaUpdateInfoDto; import org.openapitools.client.model.ProblemDetails; +import org.openapitools.client.model.SortOrder; import org.openapitools.client.model.ThemeMediaResult; import java.util.UUID; @@ -94,6 +97,7 @@ public void setCustomBaseUrl(String customBaseUrl) { Status Code Description Response Headers 204 Item deleted. - 401 Unauthorized access. - + 404 Item not found. - 403 Forbidden - */ @@ -166,6 +170,7 @@ private okhttp3.Call deleteItemValidateBeforeCall(UUID itemId, final ApiCallback Status Code Description Response Headers 204 Item deleted. - 401 Unauthorized access. - + 404 Item not found. - 403 Forbidden - */ @@ -185,6 +190,7 @@ public void deleteItem(UUID itemId) throws ApiException { Status Code Description Response Headers 204 Item deleted. - 401 Unauthorized access. - + 404 Item not found. - 403 Forbidden - */ @@ -206,6 +212,7 @@ public ApiResponse deleteItemWithHttpInfo(UUID itemId) throws ApiException Status Code Description Response Headers 204 Item deleted. - 401 Unauthorized access. - + 404 Item not found. - 403 Forbidden - */ @@ -227,6 +234,7 @@ public okhttp3.Call deleteItemAsync(UUID itemId, final ApiCallback _callba Status Code Description Response Headers 204 Items deleted. - 401 Unauthorized access. - + 404 Not Found - 403 Forbidden - */ @@ -297,6 +305,7 @@ private okhttp3.Call deleteItemsValidateBeforeCall(List ids, final ApiCall Status Code Description Response Headers 204 Items deleted. - 401 Unauthorized access. - + 404 Not Found - 403 Forbidden - */ @@ -316,6 +325,7 @@ public void deleteItems(List ids) throws ApiException { Status Code Description Response Headers 204 Items deleted. - 401 Unauthorized access. - + 404 Not Found - 403 Forbidden - */ @@ -337,6 +347,7 @@ public ApiResponse deleteItemsWithHttpInfo(List ids) throws ApiExcep Status Code Description Response Headers 204 Items deleted. - 401 Unauthorized access. - + 404 Not Found - 403 Forbidden - */ @@ -1086,7 +1097,7 @@ public okhttp3.Call getItemCountsAsync(UUID userId, Boolean isFavorite, final Ap 403 Forbidden - */ - public okhttp3.Call getLibraryOptionsInfoCall(String libraryContentType, Boolean isNewLibrary, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getLibraryOptionsInfoCall(CollectionType libraryContentType, Boolean isNewLibrary, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1141,7 +1152,7 @@ public okhttp3.Call getLibraryOptionsInfoCall(String libraryContentType, Boolean } @SuppressWarnings("rawtypes") - private okhttp3.Call getLibraryOptionsInfoValidateBeforeCall(String libraryContentType, Boolean isNewLibrary, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getLibraryOptionsInfoValidateBeforeCall(CollectionType libraryContentType, Boolean isNewLibrary, final ApiCallback _callback) throws ApiException { return getLibraryOptionsInfoCall(libraryContentType, isNewLibrary, _callback); } @@ -1162,7 +1173,7 @@ private okhttp3.Call getLibraryOptionsInfoValidateBeforeCall(String libraryConte 403 Forbidden - */ - public LibraryOptionsResultDto getLibraryOptionsInfo(String libraryContentType, Boolean isNewLibrary) throws ApiException { + public LibraryOptionsResultDto getLibraryOptionsInfo(CollectionType libraryContentType, Boolean isNewLibrary) throws ApiException { ApiResponse localVarResp = getLibraryOptionsInfoWithHttpInfo(libraryContentType, isNewLibrary); return localVarResp.getData(); } @@ -1183,7 +1194,7 @@ public LibraryOptionsResultDto getLibraryOptionsInfo(String libraryContentType, 403 Forbidden - */ - public ApiResponse getLibraryOptionsInfoWithHttpInfo(String libraryContentType, Boolean isNewLibrary) throws ApiException { + public ApiResponse getLibraryOptionsInfoWithHttpInfo(CollectionType libraryContentType, Boolean isNewLibrary) throws ApiException { okhttp3.Call localVarCall = getLibraryOptionsInfoValidateBeforeCall(libraryContentType, isNewLibrary, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); @@ -1206,7 +1217,7 @@ public ApiResponse getLibraryOptionsInfoWithHttpInfo(St 403 Forbidden - */ - public okhttp3.Call getLibraryOptionsInfoAsync(String libraryContentType, Boolean isNewLibrary, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getLibraryOptionsInfoAsync(CollectionType libraryContentType, Boolean isNewLibrary, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getLibraryOptionsInfoValidateBeforeCall(libraryContentType, isNewLibrary, _callback); Type localVarReturnType = new TypeToken(){}.getType(); @@ -2494,6 +2505,8 @@ public okhttp3.Call getSimilarTrailersAsync(UUID itemId, List excludeArtis * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param inheritFromParent Optional. Determines whether or not parent items should be searched for theme media. (optional, default to false) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param sortOrder Optional. Sort Order - Ascending, Descending. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -2507,7 +2520,7 @@ public okhttp3.Call getSimilarTrailersAsync(UUID itemId, List excludeArtis 403 Forbidden - */ - public okhttp3.Call getThemeMediaCall(UUID itemId, UUID userId, Boolean inheritFromParent, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getThemeMediaCall(UUID itemId, UUID userId, Boolean inheritFromParent, List sortBy, List sortOrder, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -2541,6 +2554,14 @@ public okhttp3.Call getThemeMediaCall(UUID itemId, UUID userId, Boolean inheritF localVarQueryParams.addAll(localVarApiClient.parameterToPair("inheritFromParent", inheritFromParent)); } + if (sortBy != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "sortBy", sortBy)); + } + + if (sortOrder != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "sortOrder", sortOrder)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -2563,13 +2584,13 @@ public okhttp3.Call getThemeMediaCall(UUID itemId, UUID userId, Boolean inheritF } @SuppressWarnings("rawtypes") - private okhttp3.Call getThemeMediaValidateBeforeCall(UUID itemId, UUID userId, Boolean inheritFromParent, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getThemeMediaValidateBeforeCall(UUID itemId, UUID userId, Boolean inheritFromParent, List sortBy, List sortOrder, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getThemeMedia(Async)"); } - return getThemeMediaCall(itemId, userId, inheritFromParent, _callback); + return getThemeMediaCall(itemId, userId, inheritFromParent, sortBy, sortOrder, _callback); } @@ -2579,6 +2600,8 @@ private okhttp3.Call getThemeMediaValidateBeforeCall(UUID itemId, UUID userId, B * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param inheritFromParent Optional. Determines whether or not parent items should be searched for theme media. (optional, default to false) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param sortOrder Optional. Sort Order - Ascending, Descending. (optional) * @return AllThemeMediaResult * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2591,8 +2614,8 @@ private okhttp3.Call getThemeMediaValidateBeforeCall(UUID itemId, UUID userId, B 403 Forbidden - */ - public AllThemeMediaResult getThemeMedia(UUID itemId, UUID userId, Boolean inheritFromParent) throws ApiException { - ApiResponse localVarResp = getThemeMediaWithHttpInfo(itemId, userId, inheritFromParent); + public AllThemeMediaResult getThemeMedia(UUID itemId, UUID userId, Boolean inheritFromParent, List sortBy, List sortOrder) throws ApiException { + ApiResponse localVarResp = getThemeMediaWithHttpInfo(itemId, userId, inheritFromParent, sortBy, sortOrder); return localVarResp.getData(); } @@ -2602,6 +2625,8 @@ public AllThemeMediaResult getThemeMedia(UUID itemId, UUID userId, Boolean inher * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param inheritFromParent Optional. Determines whether or not parent items should be searched for theme media. (optional, default to false) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param sortOrder Optional. Sort Order - Ascending, Descending. (optional) * @return ApiResponse<AllThemeMediaResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2614,8 +2639,8 @@ public AllThemeMediaResult getThemeMedia(UUID itemId, UUID userId, Boolean inher 403 Forbidden - */ - public ApiResponse getThemeMediaWithHttpInfo(UUID itemId, UUID userId, Boolean inheritFromParent) throws ApiException { - okhttp3.Call localVarCall = getThemeMediaValidateBeforeCall(itemId, userId, inheritFromParent, null); + public ApiResponse getThemeMediaWithHttpInfo(UUID itemId, UUID userId, Boolean inheritFromParent, List sortBy, List sortOrder) throws ApiException { + okhttp3.Call localVarCall = getThemeMediaValidateBeforeCall(itemId, userId, inheritFromParent, sortBy, sortOrder, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -2626,6 +2651,8 @@ public ApiResponse getThemeMediaWithHttpInfo(UUID itemId, U * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param inheritFromParent Optional. Determines whether or not parent items should be searched for theme media. (optional, default to false) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param sortOrder Optional. Sort Order - Ascending, Descending. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -2639,9 +2666,9 @@ public ApiResponse getThemeMediaWithHttpInfo(UUID itemId, U 403 Forbidden - */ - public okhttp3.Call getThemeMediaAsync(UUID itemId, UUID userId, Boolean inheritFromParent, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getThemeMediaAsync(UUID itemId, UUID userId, Boolean inheritFromParent, List sortBy, List sortOrder, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getThemeMediaValidateBeforeCall(itemId, userId, inheritFromParent, _callback); + okhttp3.Call localVarCall = getThemeMediaValidateBeforeCall(itemId, userId, inheritFromParent, sortBy, sortOrder, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -2651,6 +2678,8 @@ public okhttp3.Call getThemeMediaAsync(UUID itemId, UUID userId, Boolean inherit * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param inheritFromParent Optional. Determines whether or not parent items should be searched for theme media. (optional, default to false) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param sortOrder Optional. Sort Order - Ascending, Descending. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -2664,7 +2693,7 @@ public okhttp3.Call getThemeMediaAsync(UUID itemId, UUID userId, Boolean inherit 403 Forbidden - */ - public okhttp3.Call getThemeSongsCall(UUID itemId, UUID userId, Boolean inheritFromParent, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getThemeSongsCall(UUID itemId, UUID userId, Boolean inheritFromParent, List sortBy, List sortOrder, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -2698,6 +2727,14 @@ public okhttp3.Call getThemeSongsCall(UUID itemId, UUID userId, Boolean inheritF localVarQueryParams.addAll(localVarApiClient.parameterToPair("inheritFromParent", inheritFromParent)); } + if (sortBy != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "sortBy", sortBy)); + } + + if (sortOrder != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "sortOrder", sortOrder)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -2720,13 +2757,13 @@ public okhttp3.Call getThemeSongsCall(UUID itemId, UUID userId, Boolean inheritF } @SuppressWarnings("rawtypes") - private okhttp3.Call getThemeSongsValidateBeforeCall(UUID itemId, UUID userId, Boolean inheritFromParent, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getThemeSongsValidateBeforeCall(UUID itemId, UUID userId, Boolean inheritFromParent, List sortBy, List sortOrder, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getThemeSongs(Async)"); } - return getThemeSongsCall(itemId, userId, inheritFromParent, _callback); + return getThemeSongsCall(itemId, userId, inheritFromParent, sortBy, sortOrder, _callback); } @@ -2736,6 +2773,8 @@ private okhttp3.Call getThemeSongsValidateBeforeCall(UUID itemId, UUID userId, B * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param inheritFromParent Optional. Determines whether or not parent items should be searched for theme media. (optional, default to false) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param sortOrder Optional. Sort Order - Ascending, Descending. (optional) * @return ThemeMediaResult * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2748,8 +2787,8 @@ private okhttp3.Call getThemeSongsValidateBeforeCall(UUID itemId, UUID userId, B 403 Forbidden - */ - public ThemeMediaResult getThemeSongs(UUID itemId, UUID userId, Boolean inheritFromParent) throws ApiException { - ApiResponse localVarResp = getThemeSongsWithHttpInfo(itemId, userId, inheritFromParent); + public ThemeMediaResult getThemeSongs(UUID itemId, UUID userId, Boolean inheritFromParent, List sortBy, List sortOrder) throws ApiException { + ApiResponse localVarResp = getThemeSongsWithHttpInfo(itemId, userId, inheritFromParent, sortBy, sortOrder); return localVarResp.getData(); } @@ -2759,6 +2798,8 @@ public ThemeMediaResult getThemeSongs(UUID itemId, UUID userId, Boolean inheritF * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param inheritFromParent Optional. Determines whether or not parent items should be searched for theme media. (optional, default to false) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param sortOrder Optional. Sort Order - Ascending, Descending. (optional) * @return ApiResponse<ThemeMediaResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2771,8 +2812,8 @@ public ThemeMediaResult getThemeSongs(UUID itemId, UUID userId, Boolean inheritF 403 Forbidden - */ - public ApiResponse getThemeSongsWithHttpInfo(UUID itemId, UUID userId, Boolean inheritFromParent) throws ApiException { - okhttp3.Call localVarCall = getThemeSongsValidateBeforeCall(itemId, userId, inheritFromParent, null); + public ApiResponse getThemeSongsWithHttpInfo(UUID itemId, UUID userId, Boolean inheritFromParent, List sortBy, List sortOrder) throws ApiException { + okhttp3.Call localVarCall = getThemeSongsValidateBeforeCall(itemId, userId, inheritFromParent, sortBy, sortOrder, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -2783,6 +2824,8 @@ public ApiResponse getThemeSongsWithHttpInfo(UUID itemId, UUID * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param inheritFromParent Optional. Determines whether or not parent items should be searched for theme media. (optional, default to false) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param sortOrder Optional. Sort Order - Ascending, Descending. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -2796,9 +2839,9 @@ public ApiResponse getThemeSongsWithHttpInfo(UUID itemId, UUID 403 Forbidden - */ - public okhttp3.Call getThemeSongsAsync(UUID itemId, UUID userId, Boolean inheritFromParent, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getThemeSongsAsync(UUID itemId, UUID userId, Boolean inheritFromParent, List sortBy, List sortOrder, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getThemeSongsValidateBeforeCall(itemId, userId, inheritFromParent, _callback); + okhttp3.Call localVarCall = getThemeSongsValidateBeforeCall(itemId, userId, inheritFromParent, sortBy, sortOrder, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -2808,6 +2851,8 @@ public okhttp3.Call getThemeSongsAsync(UUID itemId, UUID userId, Boolean inherit * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param inheritFromParent Optional. Determines whether or not parent items should be searched for theme media. (optional, default to false) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param sortOrder Optional. Sort Order - Ascending, Descending. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -2821,7 +2866,7 @@ public okhttp3.Call getThemeSongsAsync(UUID itemId, UUID userId, Boolean inherit 403 Forbidden - */ - public okhttp3.Call getThemeVideosCall(UUID itemId, UUID userId, Boolean inheritFromParent, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getThemeVideosCall(UUID itemId, UUID userId, Boolean inheritFromParent, List sortBy, List sortOrder, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -2855,6 +2900,14 @@ public okhttp3.Call getThemeVideosCall(UUID itemId, UUID userId, Boolean inherit localVarQueryParams.addAll(localVarApiClient.parameterToPair("inheritFromParent", inheritFromParent)); } + if (sortBy != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "sortBy", sortBy)); + } + + if (sortOrder != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "sortOrder", sortOrder)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -2877,13 +2930,13 @@ public okhttp3.Call getThemeVideosCall(UUID itemId, UUID userId, Boolean inherit } @SuppressWarnings("rawtypes") - private okhttp3.Call getThemeVideosValidateBeforeCall(UUID itemId, UUID userId, Boolean inheritFromParent, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getThemeVideosValidateBeforeCall(UUID itemId, UUID userId, Boolean inheritFromParent, List sortBy, List sortOrder, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getThemeVideos(Async)"); } - return getThemeVideosCall(itemId, userId, inheritFromParent, _callback); + return getThemeVideosCall(itemId, userId, inheritFromParent, sortBy, sortOrder, _callback); } @@ -2893,6 +2946,8 @@ private okhttp3.Call getThemeVideosValidateBeforeCall(UUID itemId, UUID userId, * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param inheritFromParent Optional. Determines whether or not parent items should be searched for theme media. (optional, default to false) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param sortOrder Optional. Sort Order - Ascending, Descending. (optional) * @return ThemeMediaResult * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2905,8 +2960,8 @@ private okhttp3.Call getThemeVideosValidateBeforeCall(UUID itemId, UUID userId, 403 Forbidden - */ - public ThemeMediaResult getThemeVideos(UUID itemId, UUID userId, Boolean inheritFromParent) throws ApiException { - ApiResponse localVarResp = getThemeVideosWithHttpInfo(itemId, userId, inheritFromParent); + public ThemeMediaResult getThemeVideos(UUID itemId, UUID userId, Boolean inheritFromParent, List sortBy, List sortOrder) throws ApiException { + ApiResponse localVarResp = getThemeVideosWithHttpInfo(itemId, userId, inheritFromParent, sortBy, sortOrder); return localVarResp.getData(); } @@ -2916,6 +2971,8 @@ public ThemeMediaResult getThemeVideos(UUID itemId, UUID userId, Boolean inherit * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param inheritFromParent Optional. Determines whether or not parent items should be searched for theme media. (optional, default to false) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param sortOrder Optional. Sort Order - Ascending, Descending. (optional) * @return ApiResponse<ThemeMediaResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2928,8 +2985,8 @@ public ThemeMediaResult getThemeVideos(UUID itemId, UUID userId, Boolean inherit 403 Forbidden - */ - public ApiResponse getThemeVideosWithHttpInfo(UUID itemId, UUID userId, Boolean inheritFromParent) throws ApiException { - okhttp3.Call localVarCall = getThemeVideosValidateBeforeCall(itemId, userId, inheritFromParent, null); + public ApiResponse getThemeVideosWithHttpInfo(UUID itemId, UUID userId, Boolean inheritFromParent, List sortBy, List sortOrder) throws ApiException { + okhttp3.Call localVarCall = getThemeVideosValidateBeforeCall(itemId, userId, inheritFromParent, sortBy, sortOrder, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -2940,6 +2997,8 @@ public ApiResponse getThemeVideosWithHttpInfo(UUID itemId, UUI * @param itemId The item id. (required) * @param userId Optional. Filter by user id, and attach user data. (optional) * @param inheritFromParent Optional. Determines whether or not parent items should be searched for theme media. (optional, default to false) + * @param sortBy Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional) + * @param sortOrder Optional. Sort Order - Ascending, Descending. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -2953,9 +3012,9 @@ public ApiResponse getThemeVideosWithHttpInfo(UUID itemId, UUI 403 Forbidden - */ - public okhttp3.Call getThemeVideosAsync(UUID itemId, UUID userId, Boolean inheritFromParent, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getThemeVideosAsync(UUID itemId, UUID userId, Boolean inheritFromParent, List sortBy, List sortOrder, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getThemeVideosValidateBeforeCall(itemId, userId, inheritFromParent, _callback); + okhttp3.Call localVarCall = getThemeVideosValidateBeforeCall(itemId, userId, inheritFromParent, sortBy, sortOrder, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/LibraryStructureApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/LibraryStructureApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/LibraryStructureApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/LibraryStructureApi.java index 8afc657d3fed4..e752320ebcd5d 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/LibraryStructureApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/LibraryStructureApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -950,6 +950,7 @@ public okhttp3.Call renameVirtualFolderAsync(String name, String newName, Boolea Response Details Status Code Description Response Headers 204 Library updated. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -980,6 +981,9 @@ public okhttp3.Call updateLibraryOptionsCall(UpdateLibraryOptionsDto updateLibra Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -1016,6 +1020,7 @@ private okhttp3.Call updateLibraryOptionsValidateBeforeCall(UpdateLibraryOptions Response Details Status Code Description Response Headers 204 Library updated. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1035,6 +1040,7 @@ public void updateLibraryOptions(UpdateLibraryOptionsDto updateLibraryOptionsDto Response Details Status Code Description Response Headers 204 Library updated. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1056,6 +1062,7 @@ public ApiResponse updateLibraryOptionsWithHttpInfo(UpdateLibraryOptionsDt Response Details Status Code Description Response Headers 204 Library updated. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/LiveTvApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/LiveTvApi.java similarity index 98% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/LiveTvApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/LiveTvApi.java index fe7e7966fdc6b..b5ed28684e477 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/LiveTvApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/LiveTvApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -36,6 +36,7 @@ import org.openapitools.client.model.GuideInfo; import org.openapitools.client.model.ImageType; import org.openapitools.client.model.ItemFields; +import org.openapitools.client.model.ItemSortBy; import org.openapitools.client.model.ListingsProviderInfo; import org.openapitools.client.model.LiveTvInfo; import org.openapitools.client.model.NameIdPair; @@ -1576,6 +1577,7 @@ public okhttp3.Call discvoverTunersAsync(Boolean newDevicesOnly, final ApiCallba Response Details Status Code Description Response Headers 200 Live tv channel returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1654,6 +1656,7 @@ private okhttp3.Call getChannelValidateBeforeCall(UUID channelId, UUID userId, f Response Details Status Code Description Response Headers 200 Live tv channel returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1675,6 +1678,7 @@ public BaseItemDto getChannel(UUID channelId, UUID userId) throws ApiException { Response Details Status Code Description Response Headers 200 Live tv channel returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1698,6 +1702,7 @@ public ApiResponse getChannelWithHttpInfo(UUID channelId, UUID user Response Details Status Code Description Response Headers 200 Live tv channel returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -2705,7 +2710,7 @@ public okhttp3.Call getLiveStreamFileAsync(String streamId, String container, fi 403 Forbidden - */ - public okhttp3.Call getLiveTvChannelsCall(ChannelType type, UUID userId, Integer startIndex, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer limit, Boolean isFavorite, Boolean isLiked, Boolean isDisliked, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, List fields, Boolean enableUserData, List sortBy, SortOrder sortOrder, Boolean enableFavoriteSorting, Boolean addCurrentProgram, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getLiveTvChannelsCall(ChannelType type, UUID userId, Integer startIndex, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer limit, Boolean isFavorite, Boolean isLiked, Boolean isDisliked, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, List fields, Boolean enableUserData, List sortBy, SortOrder sortOrder, Boolean enableFavoriteSorting, Boolean addCurrentProgram, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -2836,7 +2841,7 @@ public okhttp3.Call getLiveTvChannelsCall(ChannelType type, UUID userId, Integer } @SuppressWarnings("rawtypes") - private okhttp3.Call getLiveTvChannelsValidateBeforeCall(ChannelType type, UUID userId, Integer startIndex, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer limit, Boolean isFavorite, Boolean isLiked, Boolean isDisliked, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, List fields, Boolean enableUserData, List sortBy, SortOrder sortOrder, Boolean enableFavoriteSorting, Boolean addCurrentProgram, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getLiveTvChannelsValidateBeforeCall(ChannelType type, UUID userId, Integer startIndex, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer limit, Boolean isFavorite, Boolean isLiked, Boolean isDisliked, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, List fields, Boolean enableUserData, List sortBy, SortOrder sortOrder, Boolean enableFavoriteSorting, Boolean addCurrentProgram, final ApiCallback _callback) throws ApiException { return getLiveTvChannelsCall(type, userId, startIndex, isMovie, isSeries, isNews, isKids, isSports, limit, isFavorite, isLiked, isDisliked, enableImages, imageTypeLimit, enableImageTypes, fields, enableUserData, sortBy, sortOrder, enableFavoriteSorting, addCurrentProgram, _callback); } @@ -2876,7 +2881,7 @@ private okhttp3.Call getLiveTvChannelsValidateBeforeCall(ChannelType type, UUID 403 Forbidden - */ - public BaseItemDtoQueryResult getLiveTvChannels(ChannelType type, UUID userId, Integer startIndex, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer limit, Boolean isFavorite, Boolean isLiked, Boolean isDisliked, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, List fields, Boolean enableUserData, List sortBy, SortOrder sortOrder, Boolean enableFavoriteSorting, Boolean addCurrentProgram) throws ApiException { + public BaseItemDtoQueryResult getLiveTvChannels(ChannelType type, UUID userId, Integer startIndex, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer limit, Boolean isFavorite, Boolean isLiked, Boolean isDisliked, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, List fields, Boolean enableUserData, List sortBy, SortOrder sortOrder, Boolean enableFavoriteSorting, Boolean addCurrentProgram) throws ApiException { ApiResponse localVarResp = getLiveTvChannelsWithHttpInfo(type, userId, startIndex, isMovie, isSeries, isNews, isKids, isSports, limit, isFavorite, isLiked, isDisliked, enableImages, imageTypeLimit, enableImageTypes, fields, enableUserData, sortBy, sortOrder, enableFavoriteSorting, addCurrentProgram); return localVarResp.getData(); } @@ -2916,7 +2921,7 @@ public BaseItemDtoQueryResult getLiveTvChannels(ChannelType type, UUID userId, I 403 Forbidden - */ - public ApiResponse getLiveTvChannelsWithHttpInfo(ChannelType type, UUID userId, Integer startIndex, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer limit, Boolean isFavorite, Boolean isLiked, Boolean isDisliked, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, List fields, Boolean enableUserData, List sortBy, SortOrder sortOrder, Boolean enableFavoriteSorting, Boolean addCurrentProgram) throws ApiException { + public ApiResponse getLiveTvChannelsWithHttpInfo(ChannelType type, UUID userId, Integer startIndex, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer limit, Boolean isFavorite, Boolean isLiked, Boolean isDisliked, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, List fields, Boolean enableUserData, List sortBy, SortOrder sortOrder, Boolean enableFavoriteSorting, Boolean addCurrentProgram) throws ApiException { okhttp3.Call localVarCall = getLiveTvChannelsValidateBeforeCall(type, userId, startIndex, isMovie, isSeries, isNews, isKids, isSports, limit, isFavorite, isLiked, isDisliked, enableImages, imageTypeLimit, enableImageTypes, fields, enableUserData, sortBy, sortOrder, enableFavoriteSorting, addCurrentProgram, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); @@ -2958,7 +2963,7 @@ public ApiResponse getLiveTvChannelsWithHttpInfo(Channel 403 Forbidden - */ - public okhttp3.Call getLiveTvChannelsAsync(ChannelType type, UUID userId, Integer startIndex, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer limit, Boolean isFavorite, Boolean isLiked, Boolean isDisliked, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, List fields, Boolean enableUserData, List sortBy, SortOrder sortOrder, Boolean enableFavoriteSorting, Boolean addCurrentProgram, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getLiveTvChannelsAsync(ChannelType type, UUID userId, Integer startIndex, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer limit, Boolean isFavorite, Boolean isLiked, Boolean isDisliked, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, List fields, Boolean enableUserData, List sortBy, SortOrder sortOrder, Boolean enableFavoriteSorting, Boolean addCurrentProgram, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getLiveTvChannelsValidateBeforeCall(type, userId, startIndex, isMovie, isSeries, isNews, isKids, isSports, limit, isFavorite, isLiked, isDisliked, enableImages, imageTypeLimit, enableImageTypes, fields, enableUserData, sortBy, sortOrder, enableFavoriteSorting, addCurrentProgram, _callback); Type localVarReturnType = new TypeToken(){}.getType(); @@ -3133,7 +3138,7 @@ public okhttp3.Call getLiveTvInfoAsync(final ApiCallback _callback) 403 Forbidden - */ - public okhttp3.Call getLiveTvProgramsCall(List channelIds, UUID userId, OffsetDateTime minStartDate, Boolean hasAired, Boolean isAiring, OffsetDateTime maxStartDate, OffsetDateTime minEndDate, OffsetDateTime maxEndDate, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer startIndex, Integer limit, List sortBy, List sortOrder, List genres, List genreIds, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, String seriesTimerId, UUID librarySeriesId, List fields, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getLiveTvProgramsCall(List channelIds, UUID userId, OffsetDateTime minStartDate, Boolean hasAired, Boolean isAiring, OffsetDateTime maxStartDate, OffsetDateTime minEndDate, OffsetDateTime maxEndDate, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer startIndex, Integer limit, List sortBy, List sortOrder, List genres, List genreIds, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, String seriesTimerId, UUID librarySeriesId, List fields, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -3288,7 +3293,7 @@ public okhttp3.Call getLiveTvProgramsCall(List channelIds, UUID userId, Of } @SuppressWarnings("rawtypes") - private okhttp3.Call getLiveTvProgramsValidateBeforeCall(List channelIds, UUID userId, OffsetDateTime minStartDate, Boolean hasAired, Boolean isAiring, OffsetDateTime maxStartDate, OffsetDateTime minEndDate, OffsetDateTime maxEndDate, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer startIndex, Integer limit, List sortBy, List sortOrder, List genres, List genreIds, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, String seriesTimerId, UUID librarySeriesId, List fields, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getLiveTvProgramsValidateBeforeCall(List channelIds, UUID userId, OffsetDateTime minStartDate, Boolean hasAired, Boolean isAiring, OffsetDateTime maxStartDate, OffsetDateTime minEndDate, OffsetDateTime maxEndDate, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer startIndex, Integer limit, List sortBy, List sortOrder, List genres, List genreIds, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, String seriesTimerId, UUID librarySeriesId, List fields, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { return getLiveTvProgramsCall(channelIds, userId, minStartDate, hasAired, isAiring, maxStartDate, minEndDate, maxEndDate, isMovie, isSeries, isNews, isKids, isSports, startIndex, limit, sortBy, sortOrder, genres, genreIds, enableImages, imageTypeLimit, enableImageTypes, enableUserData, seriesTimerId, librarySeriesId, fields, enableTotalRecordCount, _callback); } @@ -3334,7 +3339,7 @@ private okhttp3.Call getLiveTvProgramsValidateBeforeCall(List channelIds, 403 Forbidden - */ - public BaseItemDtoQueryResult getLiveTvPrograms(List channelIds, UUID userId, OffsetDateTime minStartDate, Boolean hasAired, Boolean isAiring, OffsetDateTime maxStartDate, OffsetDateTime minEndDate, OffsetDateTime maxEndDate, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer startIndex, Integer limit, List sortBy, List sortOrder, List genres, List genreIds, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, String seriesTimerId, UUID librarySeriesId, List fields, Boolean enableTotalRecordCount) throws ApiException { + public BaseItemDtoQueryResult getLiveTvPrograms(List channelIds, UUID userId, OffsetDateTime minStartDate, Boolean hasAired, Boolean isAiring, OffsetDateTime maxStartDate, OffsetDateTime minEndDate, OffsetDateTime maxEndDate, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer startIndex, Integer limit, List sortBy, List sortOrder, List genres, List genreIds, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, String seriesTimerId, UUID librarySeriesId, List fields, Boolean enableTotalRecordCount) throws ApiException { ApiResponse localVarResp = getLiveTvProgramsWithHttpInfo(channelIds, userId, minStartDate, hasAired, isAiring, maxStartDate, minEndDate, maxEndDate, isMovie, isSeries, isNews, isKids, isSports, startIndex, limit, sortBy, sortOrder, genres, genreIds, enableImages, imageTypeLimit, enableImageTypes, enableUserData, seriesTimerId, librarySeriesId, fields, enableTotalRecordCount); return localVarResp.getData(); } @@ -3380,7 +3385,7 @@ public BaseItemDtoQueryResult getLiveTvPrograms(List channelIds, UUID user 403 Forbidden - */ - public ApiResponse getLiveTvProgramsWithHttpInfo(List channelIds, UUID userId, OffsetDateTime minStartDate, Boolean hasAired, Boolean isAiring, OffsetDateTime maxStartDate, OffsetDateTime minEndDate, OffsetDateTime maxEndDate, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer startIndex, Integer limit, List sortBy, List sortOrder, List genres, List genreIds, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, String seriesTimerId, UUID librarySeriesId, List fields, Boolean enableTotalRecordCount) throws ApiException { + public ApiResponse getLiveTvProgramsWithHttpInfo(List channelIds, UUID userId, OffsetDateTime minStartDate, Boolean hasAired, Boolean isAiring, OffsetDateTime maxStartDate, OffsetDateTime minEndDate, OffsetDateTime maxEndDate, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer startIndex, Integer limit, List sortBy, List sortOrder, List genres, List genreIds, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, String seriesTimerId, UUID librarySeriesId, List fields, Boolean enableTotalRecordCount) throws ApiException { okhttp3.Call localVarCall = getLiveTvProgramsValidateBeforeCall(channelIds, userId, minStartDate, hasAired, isAiring, maxStartDate, minEndDate, maxEndDate, isMovie, isSeries, isNews, isKids, isSports, startIndex, limit, sortBy, sortOrder, genres, genreIds, enableImages, imageTypeLimit, enableImageTypes, enableUserData, seriesTimerId, librarySeriesId, fields, enableTotalRecordCount, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); @@ -3428,7 +3433,7 @@ public ApiResponse getLiveTvProgramsWithHttpInfo(List 403 Forbidden - */ - public okhttp3.Call getLiveTvProgramsAsync(List channelIds, UUID userId, OffsetDateTime minStartDate, Boolean hasAired, Boolean isAiring, OffsetDateTime maxStartDate, OffsetDateTime minEndDate, OffsetDateTime maxEndDate, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer startIndex, Integer limit, List sortBy, List sortOrder, List genres, List genreIds, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, String seriesTimerId, UUID librarySeriesId, List fields, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getLiveTvProgramsAsync(List channelIds, UUID userId, OffsetDateTime minStartDate, Boolean hasAired, Boolean isAiring, OffsetDateTime maxStartDate, OffsetDateTime minEndDate, OffsetDateTime maxEndDate, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Integer startIndex, Integer limit, List sortBy, List sortOrder, List genres, List genreIds, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, String seriesTimerId, UUID librarySeriesId, List fields, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getLiveTvProgramsValidateBeforeCall(channelIds, userId, minStartDate, hasAired, isAiring, maxStartDate, minEndDate, maxEndDate, isMovie, isSeries, isNews, isKids, isSports, startIndex, limit, sortBy, sortOrder, genres, genreIds, enableImages, imageTypeLimit, enableImageTypes, enableUserData, seriesTimerId, librarySeriesId, fields, enableTotalRecordCount, _callback); Type localVarReturnType = new TypeToken(){}.getType(); @@ -3981,6 +3986,7 @@ public okhttp3.Call getRecommendedProgramsAsync(UUID userId, Integer limit, Bool Response Details Status Code Description Response Headers 200 Recording returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -4059,6 +4065,7 @@ private okhttp3.Call getRecordingValidateBeforeCall(UUID recordingId, UUID userI Response Details Status Code Description Response Headers 200 Recording returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -4080,6 +4087,7 @@ public BaseItemDto getRecording(UUID recordingId, UUID userId) throws ApiExcepti Response Details Status Code Description Response Headers 200 Recording returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -4103,6 +4111,7 @@ public ApiResponse getRecordingWithHttpInfo(UUID recordingId, UUID Response Details Status Code Description Response Headers 200 Recording returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/LocalizationApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/LocalizationApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/LocalizationApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/LocalizationApi.java index 45e2497047eca..94a8d0ef4bc9a 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/LocalizationApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/LocalizationApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/LyricsApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/LyricsApi.java new file mode 100644 index 0000000000000..619fd7a471050 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/LyricsApi.java @@ -0,0 +1,953 @@ +/* + * Jellyfin API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 10.10.3 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package org.openapitools.client.api; + +import org.openapitools.client.ApiCallback; +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.ApiResponse; +import org.openapitools.client.Configuration; +import org.openapitools.client.Pair; +import org.openapitools.client.ProgressRequestBody; +import org.openapitools.client.ProgressResponseBody; + +import com.google.gson.reflect.TypeToken; + +import java.io.IOException; + + +import java.io.File; +import org.openapitools.client.model.LyricDto; +import org.openapitools.client.model.ProblemDetails; +import org.openapitools.client.model.RemoteLyricInfoDto; +import java.util.UUID; + +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class LyricsApi { + private ApiClient localVarApiClient; + private int localHostIndex; + private String localCustomBaseUrl; + + public LyricsApi() { + this(Configuration.getDefaultApiClient()); + } + + public LyricsApi(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + public ApiClient getApiClient() { + return localVarApiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + public int getHostIndex() { + return localHostIndex; + } + + public void setHostIndex(int hostIndex) { + this.localHostIndex = hostIndex; + } + + public String getCustomBaseUrl() { + return localCustomBaseUrl; + } + + public void setCustomBaseUrl(String customBaseUrl) { + this.localCustomBaseUrl = customBaseUrl; + } + + /** + * Build call for deleteLyrics + * @param itemId The item id. (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Lyric deleted. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call deleteLyricsCall(UUID itemId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Audio/{itemId}/Lyrics" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call deleteLyricsValidateBeforeCall(UUID itemId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling deleteLyrics(Async)"); + } + + return deleteLyricsCall(itemId, _callback); + + } + + /** + * Deletes an external lyric file. + * + * @param itemId The item id. (required) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Lyric deleted. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public void deleteLyrics(UUID itemId) throws ApiException { + deleteLyricsWithHttpInfo(itemId); + } + + /** + * Deletes an external lyric file. + * + * @param itemId The item id. (required) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Lyric deleted. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public ApiResponse deleteLyricsWithHttpInfo(UUID itemId) throws ApiException { + okhttp3.Call localVarCall = deleteLyricsValidateBeforeCall(itemId, null); + return localVarApiClient.execute(localVarCall); + } + + /** + * Deletes an external lyric file. (asynchronously) + * + * @param itemId The item id. (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Lyric deleted. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call deleteLyricsAsync(UUID itemId, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = deleteLyricsValidateBeforeCall(itemId, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); + return localVarCall; + } + /** + * Build call for downloadRemoteLyrics + * @param itemId The item id. (required) + * @param lyricId The lyric id. (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyric downloaded. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call downloadRemoteLyricsCall(UUID itemId, String lyricId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Audio/{itemId}/RemoteSearch/Lyrics/{lyricId}" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())) + .replace("{" + "lyricId" + "}", localVarApiClient.escapeString(lyricId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call downloadRemoteLyricsValidateBeforeCall(UUID itemId, String lyricId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling downloadRemoteLyrics(Async)"); + } + + // verify the required parameter 'lyricId' is set + if (lyricId == null) { + throw new ApiException("Missing the required parameter 'lyricId' when calling downloadRemoteLyrics(Async)"); + } + + return downloadRemoteLyricsCall(itemId, lyricId, _callback); + + } + + /** + * Downloads a remote lyric. + * + * @param itemId The item id. (required) + * @param lyricId The lyric id. (required) + * @return LyricDto + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyric downloaded. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public LyricDto downloadRemoteLyrics(UUID itemId, String lyricId) throws ApiException { + ApiResponse localVarResp = downloadRemoteLyricsWithHttpInfo(itemId, lyricId); + return localVarResp.getData(); + } + + /** + * Downloads a remote lyric. + * + * @param itemId The item id. (required) + * @param lyricId The lyric id. (required) + * @return ApiResponse<LyricDto> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyric downloaded. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public ApiResponse downloadRemoteLyricsWithHttpInfo(UUID itemId, String lyricId) throws ApiException { + okhttp3.Call localVarCall = downloadRemoteLyricsValidateBeforeCall(itemId, lyricId, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Downloads a remote lyric. (asynchronously) + * + * @param itemId The item id. (required) + * @param lyricId The lyric id. (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyric downloaded. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call downloadRemoteLyricsAsync(UUID itemId, String lyricId, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = downloadRemoteLyricsValidateBeforeCall(itemId, lyricId, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for getLyrics + * @param itemId Item id. (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyrics returned. -
404 Something went wrong. No Lyrics will be returned. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getLyricsCall(UUID itemId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Audio/{itemId}/Lyrics" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getLyricsValidateBeforeCall(UUID itemId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling getLyrics(Async)"); + } + + return getLyricsCall(itemId, _callback); + + } + + /** + * Gets an item's lyrics. + * + * @param itemId Item id. (required) + * @return LyricDto + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyrics returned. -
404 Something went wrong. No Lyrics will be returned. -
401 Unauthorized -
403 Forbidden -
+ */ + public LyricDto getLyrics(UUID itemId) throws ApiException { + ApiResponse localVarResp = getLyricsWithHttpInfo(itemId); + return localVarResp.getData(); + } + + /** + * Gets an item's lyrics. + * + * @param itemId Item id. (required) + * @return ApiResponse<LyricDto> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyrics returned. -
404 Something went wrong. No Lyrics will be returned. -
401 Unauthorized -
403 Forbidden -
+ */ + public ApiResponse getLyricsWithHttpInfo(UUID itemId) throws ApiException { + okhttp3.Call localVarCall = getLyricsValidateBeforeCall(itemId, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Gets an item's lyrics. (asynchronously) + * + * @param itemId Item id. (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyrics returned. -
404 Something went wrong. No Lyrics will be returned. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getLyricsAsync(UUID itemId, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getLyricsValidateBeforeCall(itemId, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for getRemoteLyrics + * @param lyricId The remote provider item id. (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 File returned. -
404 Lyric not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getRemoteLyricsCall(String lyricId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Providers/Lyrics/{lyricId}" + .replace("{" + "lyricId" + "}", localVarApiClient.escapeString(lyricId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getRemoteLyricsValidateBeforeCall(String lyricId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'lyricId' is set + if (lyricId == null) { + throw new ApiException("Missing the required parameter 'lyricId' when calling getRemoteLyrics(Async)"); + } + + return getRemoteLyricsCall(lyricId, _callback); + + } + + /** + * Gets the remote lyrics. + * + * @param lyricId The remote provider item id. (required) + * @return LyricDto + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 File returned. -
404 Lyric not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public LyricDto getRemoteLyrics(String lyricId) throws ApiException { + ApiResponse localVarResp = getRemoteLyricsWithHttpInfo(lyricId); + return localVarResp.getData(); + } + + /** + * Gets the remote lyrics. + * + * @param lyricId The remote provider item id. (required) + * @return ApiResponse<LyricDto> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 File returned. -
404 Lyric not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public ApiResponse getRemoteLyricsWithHttpInfo(String lyricId) throws ApiException { + okhttp3.Call localVarCall = getRemoteLyricsValidateBeforeCall(lyricId, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Gets the remote lyrics. (asynchronously) + * + * @param lyricId The remote provider item id. (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 File returned. -
404 Lyric not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getRemoteLyricsAsync(String lyricId, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getRemoteLyricsValidateBeforeCall(lyricId, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for searchRemoteLyrics + * @param itemId The item id. (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyrics retrieved. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call searchRemoteLyricsCall(UUID itemId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Audio/{itemId}/RemoteSearch/Lyrics" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call searchRemoteLyricsValidateBeforeCall(UUID itemId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling searchRemoteLyrics(Async)"); + } + + return searchRemoteLyricsCall(itemId, _callback); + + } + + /** + * Search remote lyrics. + * + * @param itemId The item id. (required) + * @return List<RemoteLyricInfoDto> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyrics retrieved. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public List searchRemoteLyrics(UUID itemId) throws ApiException { + ApiResponse> localVarResp = searchRemoteLyricsWithHttpInfo(itemId); + return localVarResp.getData(); + } + + /** + * Search remote lyrics. + * + * @param itemId The item id. (required) + * @return ApiResponse<List<RemoteLyricInfoDto>> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyrics retrieved. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public ApiResponse> searchRemoteLyricsWithHttpInfo(UUID itemId) throws ApiException { + okhttp3.Call localVarCall = searchRemoteLyricsValidateBeforeCall(itemId, null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Search remote lyrics. (asynchronously) + * + * @param itemId The item id. (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyrics retrieved. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call searchRemoteLyricsAsync(UUID itemId, final ApiCallback> _callback) throws ApiException { + + okhttp3.Call localVarCall = searchRemoteLyricsValidateBeforeCall(itemId, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for uploadLyrics + * @param itemId The item the lyric belongs to. (required) + * @param fileName Name of the file being uploaded. (required) + * @param body (optional) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyrics uploaded. -
400 Error processing upload. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call uploadLyricsCall(UUID itemId, String fileName, File body, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = body; + + // create path and map variables + String localVarPath = "/Audio/{itemId}/Lyrics" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (fileName != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("fileName", fileName)); + } + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "text/plain" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call uploadLyricsValidateBeforeCall(UUID itemId, String fileName, File body, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling uploadLyrics(Async)"); + } + + // verify the required parameter 'fileName' is set + if (fileName == null) { + throw new ApiException("Missing the required parameter 'fileName' when calling uploadLyrics(Async)"); + } + + return uploadLyricsCall(itemId, fileName, body, _callback); + + } + + /** + * Upload an external lyric file. + * + * @param itemId The item the lyric belongs to. (required) + * @param fileName Name of the file being uploaded. (required) + * @param body (optional) + * @return LyricDto + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyrics uploaded. -
400 Error processing upload. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public LyricDto uploadLyrics(UUID itemId, String fileName, File body) throws ApiException { + ApiResponse localVarResp = uploadLyricsWithHttpInfo(itemId, fileName, body); + return localVarResp.getData(); + } + + /** + * Upload an external lyric file. + * + * @param itemId The item the lyric belongs to. (required) + * @param fileName Name of the file being uploaded. (required) + * @param body (optional) + * @return ApiResponse<LyricDto> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyrics uploaded. -
400 Error processing upload. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public ApiResponse uploadLyricsWithHttpInfo(UUID itemId, String fileName, File body) throws ApiException { + okhttp3.Call localVarCall = uploadLyricsValidateBeforeCall(itemId, fileName, body, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Upload an external lyric file. (asynchronously) + * + * @param itemId The item the lyric belongs to. (required) + * @param fileName Name of the file being uploaded. (required) + * @param body (optional) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
200 Lyrics uploaded. -
400 Error processing upload. -
404 Item not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call uploadLyricsAsync(UUID itemId, String fileName, File body, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = uploadLyricsValidateBeforeCall(itemId, fileName, body, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } +} diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/MediaInfoApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/MediaInfoApi.java similarity index 94% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/MediaInfoApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/MediaInfoApi.java index 058bd4fd19bbf..f13602cd66197 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/MediaInfoApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/MediaInfoApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -32,6 +32,7 @@ import org.openapitools.client.model.OpenLiveStreamDto; import org.openapitools.client.model.PlaybackInfoDto; import org.openapitools.client.model.PlaybackInfoResponse; +import org.openapitools.client.model.ProblemDetails; import java.util.UUID; import java.lang.reflect.Type; @@ -346,7 +347,7 @@ public okhttp3.Call getBitrateTestBytesAsync(Integer size, final ApiCallbackResponse Details Status Code Description Response Headers 200 Playback info returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -417,11 +419,6 @@ private okhttp3.Call getPlaybackInfoValidateBeforeCall(UUID itemId, UUID userId, throw new ApiException("Missing the required parameter 'itemId' when calling getPlaybackInfo(Async)"); } - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling getPlaybackInfo(Async)"); - } - return getPlaybackInfoCall(itemId, userId, _callback); } @@ -430,7 +427,7 @@ private okhttp3.Call getPlaybackInfoValidateBeforeCall(UUID itemId, UUID userId, * Gets live playback media info for an item. * * @param itemId The item id. (required) - * @param userId The user id. (required) + * @param userId The user id. (optional) * @return PlaybackInfoResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -438,6 +435,7 @@ private okhttp3.Call getPlaybackInfoValidateBeforeCall(UUID itemId, UUID userId, Response Details Status Code Description Response Headers 200 Playback info returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -451,7 +449,7 @@ public PlaybackInfoResponse getPlaybackInfo(UUID itemId, UUID userId) throws Api * Gets live playback media info for an item. * * @param itemId The item id. (required) - * @param userId The user id. (required) + * @param userId The user id. (optional) * @return ApiResponse<PlaybackInfoResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -459,6 +457,7 @@ public PlaybackInfoResponse getPlaybackInfo(UUID itemId, UUID userId) throws Api Response Details Status Code Description Response Headers 200 Playback info returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -473,7 +472,7 @@ public ApiResponse getPlaybackInfoWithHttpInfo(UUID itemId * Gets live playback media info for an item. (asynchronously) * * @param itemId The item id. (required) - * @param userId The user id. (required) + * @param userId The user id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -482,6 +481,7 @@ public ApiResponse getPlaybackInfoWithHttpInfo(UUID itemId Response Details Status Code Description Response Headers 200 Playback info returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -519,6 +519,7 @@ public okhttp3.Call getPlaybackInfoAsync(UUID itemId, UUID userId, final ApiCall Response Details Status Code Description Response Headers 200 Playback info returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -666,6 +667,7 @@ private okhttp3.Call getPostedPlaybackInfoValidateBeforeCall(UUID itemId, UUID u Response Details Status Code Description Response Headers 200 Playback info returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -701,6 +703,7 @@ public PlaybackInfoResponse getPostedPlaybackInfo(UUID itemId, UUID userId, Inte Response Details Status Code Description Response Headers 200 Playback info returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -738,6 +741,7 @@ public ApiResponse getPostedPlaybackInfoWithHttpInfo(UUID Response Details Status Code Description Response Headers 200 Playback info returned. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -762,6 +766,7 @@ public okhttp3.Call getPostedPlaybackInfoAsync(UUID itemId, UUID userId, Integer * @param itemId The item id. (optional) * @param enableDirectPlay Whether to enable direct play. Default: true. (optional) * @param enableDirectStream Whether to enable direct stream. Default: true. (optional) + * @param alwaysBurnInSubtitleWhenTranscoding Always burn-in subtitle when transcoding. (optional) * @param openLiveStreamDto The open live stream dto. (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -775,7 +780,7 @@ public okhttp3.Call getPostedPlaybackInfoAsync(UUID itemId, UUID userId, Integer 403 Forbidden - */ - public okhttp3.Call openLiveStreamCall(String openToken, UUID userId, String playSessionId, Integer maxStreamingBitrate, Long startTimeTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer maxAudioChannels, UUID itemId, Boolean enableDirectPlay, Boolean enableDirectStream, OpenLiveStreamDto openLiveStreamDto, final ApiCallback _callback) throws ApiException { + public okhttp3.Call openLiveStreamCall(String openToken, UUID userId, String playSessionId, Integer maxStreamingBitrate, Long startTimeTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer maxAudioChannels, UUID itemId, Boolean enableDirectPlay, Boolean enableDirectStream, Boolean alwaysBurnInSubtitleWhenTranscoding, OpenLiveStreamDto openLiveStreamDto, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -844,6 +849,10 @@ public okhttp3.Call openLiveStreamCall(String openToken, UUID userId, String pla localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableDirectStream", enableDirectStream)); } + if (alwaysBurnInSubtitleWhenTranscoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("alwaysBurnInSubtitleWhenTranscoding", alwaysBurnInSubtitleWhenTranscoding)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -869,8 +878,8 @@ public okhttp3.Call openLiveStreamCall(String openToken, UUID userId, String pla } @SuppressWarnings("rawtypes") - private okhttp3.Call openLiveStreamValidateBeforeCall(String openToken, UUID userId, String playSessionId, Integer maxStreamingBitrate, Long startTimeTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer maxAudioChannels, UUID itemId, Boolean enableDirectPlay, Boolean enableDirectStream, OpenLiveStreamDto openLiveStreamDto, final ApiCallback _callback) throws ApiException { - return openLiveStreamCall(openToken, userId, playSessionId, maxStreamingBitrate, startTimeTicks, audioStreamIndex, subtitleStreamIndex, maxAudioChannels, itemId, enableDirectPlay, enableDirectStream, openLiveStreamDto, _callback); + private okhttp3.Call openLiveStreamValidateBeforeCall(String openToken, UUID userId, String playSessionId, Integer maxStreamingBitrate, Long startTimeTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer maxAudioChannels, UUID itemId, Boolean enableDirectPlay, Boolean enableDirectStream, Boolean alwaysBurnInSubtitleWhenTranscoding, OpenLiveStreamDto openLiveStreamDto, final ApiCallback _callback) throws ApiException { + return openLiveStreamCall(openToken, userId, playSessionId, maxStreamingBitrate, startTimeTicks, audioStreamIndex, subtitleStreamIndex, maxAudioChannels, itemId, enableDirectPlay, enableDirectStream, alwaysBurnInSubtitleWhenTranscoding, openLiveStreamDto, _callback); } @@ -888,6 +897,7 @@ private okhttp3.Call openLiveStreamValidateBeforeCall(String openToken, UUID use * @param itemId The item id. (optional) * @param enableDirectPlay Whether to enable direct play. Default: true. (optional) * @param enableDirectStream Whether to enable direct stream. Default: true. (optional) + * @param alwaysBurnInSubtitleWhenTranscoding Always burn-in subtitle when transcoding. (optional) * @param openLiveStreamDto The open live stream dto. (optional) * @return LiveStreamResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -900,8 +910,8 @@ private okhttp3.Call openLiveStreamValidateBeforeCall(String openToken, UUID use 403 Forbidden - */ - public LiveStreamResponse openLiveStream(String openToken, UUID userId, String playSessionId, Integer maxStreamingBitrate, Long startTimeTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer maxAudioChannels, UUID itemId, Boolean enableDirectPlay, Boolean enableDirectStream, OpenLiveStreamDto openLiveStreamDto) throws ApiException { - ApiResponse localVarResp = openLiveStreamWithHttpInfo(openToken, userId, playSessionId, maxStreamingBitrate, startTimeTicks, audioStreamIndex, subtitleStreamIndex, maxAudioChannels, itemId, enableDirectPlay, enableDirectStream, openLiveStreamDto); + public LiveStreamResponse openLiveStream(String openToken, UUID userId, String playSessionId, Integer maxStreamingBitrate, Long startTimeTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer maxAudioChannels, UUID itemId, Boolean enableDirectPlay, Boolean enableDirectStream, Boolean alwaysBurnInSubtitleWhenTranscoding, OpenLiveStreamDto openLiveStreamDto) throws ApiException { + ApiResponse localVarResp = openLiveStreamWithHttpInfo(openToken, userId, playSessionId, maxStreamingBitrate, startTimeTicks, audioStreamIndex, subtitleStreamIndex, maxAudioChannels, itemId, enableDirectPlay, enableDirectStream, alwaysBurnInSubtitleWhenTranscoding, openLiveStreamDto); return localVarResp.getData(); } @@ -919,6 +929,7 @@ public LiveStreamResponse openLiveStream(String openToken, UUID userId, String p * @param itemId The item id. (optional) * @param enableDirectPlay Whether to enable direct play. Default: true. (optional) * @param enableDirectStream Whether to enable direct stream. Default: true. (optional) + * @param alwaysBurnInSubtitleWhenTranscoding Always burn-in subtitle when transcoding. (optional) * @param openLiveStreamDto The open live stream dto. (optional) * @return ApiResponse<LiveStreamResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -931,8 +942,8 @@ public LiveStreamResponse openLiveStream(String openToken, UUID userId, String p 403 Forbidden - */ - public ApiResponse openLiveStreamWithHttpInfo(String openToken, UUID userId, String playSessionId, Integer maxStreamingBitrate, Long startTimeTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer maxAudioChannels, UUID itemId, Boolean enableDirectPlay, Boolean enableDirectStream, OpenLiveStreamDto openLiveStreamDto) throws ApiException { - okhttp3.Call localVarCall = openLiveStreamValidateBeforeCall(openToken, userId, playSessionId, maxStreamingBitrate, startTimeTicks, audioStreamIndex, subtitleStreamIndex, maxAudioChannels, itemId, enableDirectPlay, enableDirectStream, openLiveStreamDto, null); + public ApiResponse openLiveStreamWithHttpInfo(String openToken, UUID userId, String playSessionId, Integer maxStreamingBitrate, Long startTimeTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer maxAudioChannels, UUID itemId, Boolean enableDirectPlay, Boolean enableDirectStream, Boolean alwaysBurnInSubtitleWhenTranscoding, OpenLiveStreamDto openLiveStreamDto) throws ApiException { + okhttp3.Call localVarCall = openLiveStreamValidateBeforeCall(openToken, userId, playSessionId, maxStreamingBitrate, startTimeTicks, audioStreamIndex, subtitleStreamIndex, maxAudioChannels, itemId, enableDirectPlay, enableDirectStream, alwaysBurnInSubtitleWhenTranscoding, openLiveStreamDto, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -951,6 +962,7 @@ public ApiResponse openLiveStreamWithHttpInfo(String openTok * @param itemId The item id. (optional) * @param enableDirectPlay Whether to enable direct play. Default: true. (optional) * @param enableDirectStream Whether to enable direct stream. Default: true. (optional) + * @param alwaysBurnInSubtitleWhenTranscoding Always burn-in subtitle when transcoding. (optional) * @param openLiveStreamDto The open live stream dto. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -964,9 +976,9 @@ public ApiResponse openLiveStreamWithHttpInfo(String openTok 403 Forbidden - */ - public okhttp3.Call openLiveStreamAsync(String openToken, UUID userId, String playSessionId, Integer maxStreamingBitrate, Long startTimeTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer maxAudioChannels, UUID itemId, Boolean enableDirectPlay, Boolean enableDirectStream, OpenLiveStreamDto openLiveStreamDto, final ApiCallback _callback) throws ApiException { + public okhttp3.Call openLiveStreamAsync(String openToken, UUID userId, String playSessionId, Integer maxStreamingBitrate, Long startTimeTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer maxAudioChannels, UUID itemId, Boolean enableDirectPlay, Boolean enableDirectStream, Boolean alwaysBurnInSubtitleWhenTranscoding, OpenLiveStreamDto openLiveStreamDto, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = openLiveStreamValidateBeforeCall(openToken, userId, playSessionId, maxStreamingBitrate, startTimeTicks, audioStreamIndex, subtitleStreamIndex, maxAudioChannels, itemId, enableDirectPlay, enableDirectStream, openLiveStreamDto, _callback); + okhttp3.Call localVarCall = openLiveStreamValidateBeforeCall(openToken, userId, playSessionId, maxStreamingBitrate, startTimeTicks, audioStreamIndex, subtitleStreamIndex, maxAudioChannels, itemId, enableDirectPlay, enableDirectStream, alwaysBurnInSubtitleWhenTranscoding, openLiveStreamDto, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/MediaSegmentsApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/MediaSegmentsApi.java new file mode 100644 index 0000000000000..2d311c65a023f --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/MediaSegmentsApi.java @@ -0,0 +1,227 @@ +/* + * Jellyfin API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 10.10.3 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package org.openapitools.client.api; + +import org.openapitools.client.ApiCallback; +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.ApiResponse; +import org.openapitools.client.Configuration; +import org.openapitools.client.Pair; +import org.openapitools.client.ProgressRequestBody; +import org.openapitools.client.ProgressResponseBody; + +import com.google.gson.reflect.TypeToken; + +import java.io.IOException; + + +import org.openapitools.client.model.MediaSegmentDtoQueryResult; +import org.openapitools.client.model.MediaSegmentType; +import org.openapitools.client.model.ProblemDetails; +import java.util.UUID; + +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class MediaSegmentsApi { + private ApiClient localVarApiClient; + private int localHostIndex; + private String localCustomBaseUrl; + + public MediaSegmentsApi() { + this(Configuration.getDefaultApiClient()); + } + + public MediaSegmentsApi(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + public ApiClient getApiClient() { + return localVarApiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + public int getHostIndex() { + return localHostIndex; + } + + public void setHostIndex(int hostIndex) { + this.localHostIndex = hostIndex; + } + + public String getCustomBaseUrl() { + return localCustomBaseUrl; + } + + public void setCustomBaseUrl(String customBaseUrl) { + this.localCustomBaseUrl = customBaseUrl; + } + + /** + * Build call for getItemSegments + * @param itemId The ItemId. (required) + * @param includeSegmentTypes Optional filter of requested segment types. (optional) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Success -
404 Not Found -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getItemSegmentsCall(UUID itemId, List includeSegmentTypes, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/MediaSegments/{itemId}" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (includeSegmentTypes != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "includeSegmentTypes", includeSegmentTypes)); + } + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getItemSegmentsValidateBeforeCall(UUID itemId, List includeSegmentTypes, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling getItemSegments(Async)"); + } + + return getItemSegmentsCall(itemId, includeSegmentTypes, _callback); + + } + + /** + * Gets all media segments based on an itemId. + * + * @param itemId The ItemId. (required) + * @param includeSegmentTypes Optional filter of requested segment types. (optional) + * @return MediaSegmentDtoQueryResult + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Success -
404 Not Found -
401 Unauthorized -
403 Forbidden -
+ */ + public MediaSegmentDtoQueryResult getItemSegments(UUID itemId, List includeSegmentTypes) throws ApiException { + ApiResponse localVarResp = getItemSegmentsWithHttpInfo(itemId, includeSegmentTypes); + return localVarResp.getData(); + } + + /** + * Gets all media segments based on an itemId. + * + * @param itemId The ItemId. (required) + * @param includeSegmentTypes Optional filter of requested segment types. (optional) + * @return ApiResponse<MediaSegmentDtoQueryResult> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Success -
404 Not Found -
401 Unauthorized -
403 Forbidden -
+ */ + public ApiResponse getItemSegmentsWithHttpInfo(UUID itemId, List includeSegmentTypes) throws ApiException { + okhttp3.Call localVarCall = getItemSegmentsValidateBeforeCall(itemId, includeSegmentTypes, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Gets all media segments based on an itemId. (asynchronously) + * + * @param itemId The ItemId. (required) + * @param includeSegmentTypes Optional filter of requested segment types. (optional) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Success -
404 Not Found -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getItemSegmentsAsync(UUID itemId, List includeSegmentTypes, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getItemSegmentsValidateBeforeCall(itemId, includeSegmentTypes, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } +} diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/MoviesApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/MoviesApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/MoviesApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/MoviesApi.java index bb36735920866..a3bb62d6c550a 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/MoviesApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/MoviesApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/MusicGenresApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/MusicGenresApi.java similarity index 96% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/MusicGenresApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/MusicGenresApi.java index fd0ab0d4b096c..517d9a5e0d7b3 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/MusicGenresApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/MusicGenresApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -32,6 +32,7 @@ import org.openapitools.client.model.BaseItemKind; import org.openapitools.client.model.ImageType; import org.openapitools.client.model.ItemFields; +import org.openapitools.client.model.ItemSortBy; import org.openapitools.client.model.SortOrder; import java.util.UUID; @@ -257,7 +258,7 @@ public okhttp3.Call getMusicGenreAsync(String genreName, UUID userId, final ApiC * @deprecated */ @Deprecated - public okhttp3.Call getMusicGenresCall(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getMusicGenresCall(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -377,7 +378,7 @@ public okhttp3.Call getMusicGenresCall(Integer startIndex, Integer limit, String @Deprecated @SuppressWarnings("rawtypes") - private okhttp3.Call getMusicGenresValidateBeforeCall(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getMusicGenresValidateBeforeCall(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { return getMusicGenresCall(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, _callback); } @@ -416,7 +417,7 @@ private okhttp3.Call getMusicGenresValidateBeforeCall(Integer startIndex, Intege * @deprecated */ @Deprecated - public BaseItemDtoQueryResult getMusicGenres(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { + public BaseItemDtoQueryResult getMusicGenres(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { ApiResponse localVarResp = getMusicGenresWithHttpInfo(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount); return localVarResp.getData(); } @@ -455,7 +456,7 @@ public BaseItemDtoQueryResult getMusicGenres(Integer startIndex, Integer limit, * @deprecated */ @Deprecated - public ApiResponse getMusicGenresWithHttpInfo(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { + public ApiResponse getMusicGenresWithHttpInfo(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount) throws ApiException { okhttp3.Call localVarCall = getMusicGenresValidateBeforeCall(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); @@ -496,7 +497,7 @@ public ApiResponse getMusicGenresWithHttpInfo(Integer st * @deprecated */ @Deprecated - public okhttp3.Call getMusicGenresAsync(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getMusicGenresAsync(Integer startIndex, Integer limit, String searchTerm, UUID parentId, List fields, List excludeItemTypes, List includeItemTypes, Boolean isFavorite, Integer imageTypeLimit, List enableImageTypes, UUID userId, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List sortBy, List sortOrder, Boolean enableImages, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getMusicGenresValidateBeforeCall(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, _callback); Type localVarReturnType = new TypeToken(){}.getType(); diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/PackageApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/PackageApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/PackageApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/PackageApi.java index d2f10e72c419c..f96f1865d86fe 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/PackageApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/PackageApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/PersonsApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/PersonsApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/PersonsApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/PersonsApi.java index b714f1c84f5ab..99d7cb0804c1b 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/PersonsApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/PersonsApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/PlaylistsApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/PlaylistsApi.java new file mode 100644 index 0000000000000..34f4f3d00ec05 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/PlaylistsApi.java @@ -0,0 +1,1800 @@ +/* + * Jellyfin API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 10.10.3 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package org.openapitools.client.api; + +import org.openapitools.client.ApiCallback; +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.ApiResponse; +import org.openapitools.client.Configuration; +import org.openapitools.client.Pair; +import org.openapitools.client.ProgressRequestBody; +import org.openapitools.client.ProgressResponseBody; + +import com.google.gson.reflect.TypeToken; + +import java.io.IOException; + + +import org.openapitools.client.model.BaseItemDtoQueryResult; +import org.openapitools.client.model.CreatePlaylistDto; +import org.openapitools.client.model.ImageType; +import org.openapitools.client.model.ItemFields; +import org.openapitools.client.model.MediaType; +import org.openapitools.client.model.PlaylistCreationResult; +import org.openapitools.client.model.PlaylistDto; +import org.openapitools.client.model.PlaylistUserPermissions; +import org.openapitools.client.model.ProblemDetails; +import java.util.UUID; +import org.openapitools.client.model.UpdatePlaylistDto; +import org.openapitools.client.model.UpdatePlaylistUserDto; + +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class PlaylistsApi { + private ApiClient localVarApiClient; + private int localHostIndex; + private String localCustomBaseUrl; + + public PlaylistsApi() { + this(Configuration.getDefaultApiClient()); + } + + public PlaylistsApi(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + public ApiClient getApiClient() { + return localVarApiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + public int getHostIndex() { + return localHostIndex; + } + + public void setHostIndex(int hostIndex) { + this.localHostIndex = hostIndex; + } + + public String getCustomBaseUrl() { + return localCustomBaseUrl; + } + + public void setCustomBaseUrl(String customBaseUrl) { + this.localCustomBaseUrl = customBaseUrl; + } + + /** + * Build call for addItemToPlaylist + * @param playlistId The playlist id. (required) + * @param ids Item id, comma delimited. (optional) + * @param userId The userId. (optional) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Items added to playlist. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call addItemToPlaylistCall(UUID playlistId, List ids, UUID userId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Playlists/{playlistId}/Items" + .replace("{" + "playlistId" + "}", localVarApiClient.escapeString(playlistId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (ids != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "ids", ids)); + } + + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call addItemToPlaylistValidateBeforeCall(UUID playlistId, List ids, UUID userId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'playlistId' is set + if (playlistId == null) { + throw new ApiException("Missing the required parameter 'playlistId' when calling addItemToPlaylist(Async)"); + } + + return addItemToPlaylistCall(playlistId, ids, userId, _callback); + + } + + /** + * Adds items to a playlist. + * + * @param playlistId The playlist id. (required) + * @param ids Item id, comma delimited. (optional) + * @param userId The userId. (optional) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Items added to playlist. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public void addItemToPlaylist(UUID playlistId, List ids, UUID userId) throws ApiException { + addItemToPlaylistWithHttpInfo(playlistId, ids, userId); + } + + /** + * Adds items to a playlist. + * + * @param playlistId The playlist id. (required) + * @param ids Item id, comma delimited. (optional) + * @param userId The userId. (optional) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Items added to playlist. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public ApiResponse addItemToPlaylistWithHttpInfo(UUID playlistId, List ids, UUID userId) throws ApiException { + okhttp3.Call localVarCall = addItemToPlaylistValidateBeforeCall(playlistId, ids, userId, null); + return localVarApiClient.execute(localVarCall); + } + + /** + * Adds items to a playlist. (asynchronously) + * + * @param playlistId The playlist id. (required) + * @param ids Item id, comma delimited. (optional) + * @param userId The userId. (optional) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Items added to playlist. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call addItemToPlaylistAsync(UUID playlistId, List ids, UUID userId, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = addItemToPlaylistValidateBeforeCall(playlistId, ids, userId, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); + return localVarCall; + } + /** + * Build call for createPlaylist + * @param name The playlist name. (optional) + * @param ids The item ids. (optional) + * @param userId The user id. (optional) + * @param mediaType The media type. (optional) + * @param createPlaylistDto The create playlist payload. (optional) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + +
Response Details
Status Code Description Response Headers
200 Playlist created. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call createPlaylistCall(String name, List ids, UUID userId, MediaType mediaType, CreatePlaylistDto createPlaylistDto, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = createPlaylistDto; + + // create path and map variables + String localVarPath = "/Playlists"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (name != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("name", name)); + } + + if (ids != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "ids", ids)); + } + + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + + if (mediaType != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("mediaType", mediaType)); + } + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json", + "text/json", + "application/*+json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call createPlaylistValidateBeforeCall(String name, List ids, UUID userId, MediaType mediaType, CreatePlaylistDto createPlaylistDto, final ApiCallback _callback) throws ApiException { + return createPlaylistCall(name, ids, userId, mediaType, createPlaylistDto, _callback); + + } + + /** + * Creates a new playlist. + * For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete. + * @param name The playlist name. (optional) + * @param ids The item ids. (optional) + * @param userId The user id. (optional) + * @param mediaType The media type. (optional) + * @param createPlaylistDto The create playlist payload. (optional) + * @return PlaylistCreationResult + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Response Details
Status Code Description Response Headers
200 Playlist created. -
401 Unauthorized -
403 Forbidden -
+ */ + public PlaylistCreationResult createPlaylist(String name, List ids, UUID userId, MediaType mediaType, CreatePlaylistDto createPlaylistDto) throws ApiException { + ApiResponse localVarResp = createPlaylistWithHttpInfo(name, ids, userId, mediaType, createPlaylistDto); + return localVarResp.getData(); + } + + /** + * Creates a new playlist. + * For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete. + * @param name The playlist name. (optional) + * @param ids The item ids. (optional) + * @param userId The user id. (optional) + * @param mediaType The media type. (optional) + * @param createPlaylistDto The create playlist payload. (optional) + * @return ApiResponse<PlaylistCreationResult> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Response Details
Status Code Description Response Headers
200 Playlist created. -
401 Unauthorized -
403 Forbidden -
+ */ + public ApiResponse createPlaylistWithHttpInfo(String name, List ids, UUID userId, MediaType mediaType, CreatePlaylistDto createPlaylistDto) throws ApiException { + okhttp3.Call localVarCall = createPlaylistValidateBeforeCall(name, ids, userId, mediaType, createPlaylistDto, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Creates a new playlist. (asynchronously) + * For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete. + * @param name The playlist name. (optional) + * @param ids The item ids. (optional) + * @param userId The user id. (optional) + * @param mediaType The media type. (optional) + * @param createPlaylistDto The create playlist payload. (optional) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + +
Response Details
Status Code Description Response Headers
200 Playlist created. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call createPlaylistAsync(String name, List ids, UUID userId, MediaType mediaType, CreatePlaylistDto createPlaylistDto, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = createPlaylistValidateBeforeCall(name, ids, userId, mediaType, createPlaylistDto, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for getPlaylist + * @param playlistId The playlist id. (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 The playlist. -
404 Playlist not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getPlaylistCall(UUID playlistId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Playlists/{playlistId}" + .replace("{" + "playlistId" + "}", localVarApiClient.escapeString(playlistId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getPlaylistValidateBeforeCall(UUID playlistId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'playlistId' is set + if (playlistId == null) { + throw new ApiException("Missing the required parameter 'playlistId' when calling getPlaylist(Async)"); + } + + return getPlaylistCall(playlistId, _callback); + + } + + /** + * Get a playlist. + * + * @param playlistId The playlist id. (required) + * @return PlaylistDto + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 The playlist. -
404 Playlist not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public PlaylistDto getPlaylist(UUID playlistId) throws ApiException { + ApiResponse localVarResp = getPlaylistWithHttpInfo(playlistId); + return localVarResp.getData(); + } + + /** + * Get a playlist. + * + * @param playlistId The playlist id. (required) + * @return ApiResponse<PlaylistDto> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 The playlist. -
404 Playlist not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public ApiResponse getPlaylistWithHttpInfo(UUID playlistId) throws ApiException { + okhttp3.Call localVarCall = getPlaylistValidateBeforeCall(playlistId, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Get a playlist. (asynchronously) + * + * @param playlistId The playlist id. (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 The playlist. -
404 Playlist not found. -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getPlaylistAsync(UUID playlistId, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getPlaylistValidateBeforeCall(playlistId, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for getPlaylistItems + * @param playlistId The playlist id. (required) + * @param userId User id. (optional) + * @param startIndex Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional) + * @param limit Optional. The maximum number of records to return. (optional) + * @param fields Optional. Specify additional fields of information to return in the output. (optional) + * @param enableImages Optional. Include image information in output. (optional) + * @param enableUserData Optional. Include user data. (optional) + * @param imageTypeLimit Optional. The max number of images to return, per image type. (optional) + * @param enableImageTypes Optional. The image types to include in the output. (optional) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Original playlist returned. -
403 Forbidden -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call getPlaylistItemsCall(UUID playlistId, UUID userId, Integer startIndex, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Playlists/{playlistId}/Items" + .replace("{" + "playlistId" + "}", localVarApiClient.escapeString(playlistId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + + if (startIndex != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("startIndex", startIndex)); + } + + if (limit != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); + } + + if (fields != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "fields", fields)); + } + + if (enableImages != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableImages", enableImages)); + } + + if (enableUserData != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableUserData", enableUserData)); + } + + if (imageTypeLimit != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("imageTypeLimit", imageTypeLimit)); + } + + if (enableImageTypes != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "enableImageTypes", enableImageTypes)); + } + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getPlaylistItemsValidateBeforeCall(UUID playlistId, UUID userId, Integer startIndex, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'playlistId' is set + if (playlistId == null) { + throw new ApiException("Missing the required parameter 'playlistId' when calling getPlaylistItems(Async)"); + } + + return getPlaylistItemsCall(playlistId, userId, startIndex, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); + + } + + /** + * Gets the original items of a playlist. + * + * @param playlistId The playlist id. (required) + * @param userId User id. (optional) + * @param startIndex Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional) + * @param limit Optional. The maximum number of records to return. (optional) + * @param fields Optional. Specify additional fields of information to return in the output. (optional) + * @param enableImages Optional. Include image information in output. (optional) + * @param enableUserData Optional. Include user data. (optional) + * @param imageTypeLimit Optional. The max number of images to return, per image type. (optional) + * @param enableImageTypes Optional. The image types to include in the output. (optional) + * @return BaseItemDtoQueryResult + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Original playlist returned. -
403 Forbidden -
404 Playlist not found. -
401 Unauthorized -
+ */ + public BaseItemDtoQueryResult getPlaylistItems(UUID playlistId, UUID userId, Integer startIndex, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { + ApiResponse localVarResp = getPlaylistItemsWithHttpInfo(playlistId, userId, startIndex, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes); + return localVarResp.getData(); + } + + /** + * Gets the original items of a playlist. + * + * @param playlistId The playlist id. (required) + * @param userId User id. (optional) + * @param startIndex Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional) + * @param limit Optional. The maximum number of records to return. (optional) + * @param fields Optional. Specify additional fields of information to return in the output. (optional) + * @param enableImages Optional. Include image information in output. (optional) + * @param enableUserData Optional. Include user data. (optional) + * @param imageTypeLimit Optional. The max number of images to return, per image type. (optional) + * @param enableImageTypes Optional. The image types to include in the output. (optional) + * @return ApiResponse<BaseItemDtoQueryResult> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Original playlist returned. -
403 Forbidden -
404 Playlist not found. -
401 Unauthorized -
+ */ + public ApiResponse getPlaylistItemsWithHttpInfo(UUID playlistId, UUID userId, Integer startIndex, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes) throws ApiException { + okhttp3.Call localVarCall = getPlaylistItemsValidateBeforeCall(playlistId, userId, startIndex, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Gets the original items of a playlist. (asynchronously) + * + * @param playlistId The playlist id. (required) + * @param userId User id. (optional) + * @param startIndex Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional) + * @param limit Optional. The maximum number of records to return. (optional) + * @param fields Optional. Specify additional fields of information to return in the output. (optional) + * @param enableImages Optional. Include image information in output. (optional) + * @param enableUserData Optional. Include user data. (optional) + * @param imageTypeLimit Optional. The max number of images to return, per image type. (optional) + * @param enableImageTypes Optional. The image types to include in the output. (optional) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Original playlist returned. -
403 Forbidden -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call getPlaylistItemsAsync(UUID playlistId, UUID userId, Integer startIndex, Integer limit, List fields, Boolean enableImages, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getPlaylistItemsValidateBeforeCall(playlistId, userId, startIndex, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for getPlaylistUser + * @param playlistId The playlist id. (required) + * @param userId The user id. (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 User permission found. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call getPlaylistUserCall(UUID playlistId, UUID userId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Playlists/{playlistId}/Users/{userId}" + .replace("{" + "playlistId" + "}", localVarApiClient.escapeString(playlistId.toString())) + .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getPlaylistUserValidateBeforeCall(UUID playlistId, UUID userId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'playlistId' is set + if (playlistId == null) { + throw new ApiException("Missing the required parameter 'playlistId' when calling getPlaylistUser(Async)"); + } + + // verify the required parameter 'userId' is set + if (userId == null) { + throw new ApiException("Missing the required parameter 'userId' when calling getPlaylistUser(Async)"); + } + + return getPlaylistUserCall(playlistId, userId, _callback); + + } + + /** + * Get a playlist user. + * + * @param playlistId The playlist id. (required) + * @param userId The user id. (required) + * @return PlaylistUserPermissions + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 User permission found. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public PlaylistUserPermissions getPlaylistUser(UUID playlistId, UUID userId) throws ApiException { + ApiResponse localVarResp = getPlaylistUserWithHttpInfo(playlistId, userId); + return localVarResp.getData(); + } + + /** + * Get a playlist user. + * + * @param playlistId The playlist id. (required) + * @param userId The user id. (required) + * @return ApiResponse<PlaylistUserPermissions> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 User permission found. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public ApiResponse getPlaylistUserWithHttpInfo(UUID playlistId, UUID userId) throws ApiException { + okhttp3.Call localVarCall = getPlaylistUserValidateBeforeCall(playlistId, userId, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Get a playlist user. (asynchronously) + * + * @param playlistId The playlist id. (required) + * @param userId The user id. (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 User permission found. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call getPlaylistUserAsync(UUID playlistId, UUID userId, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getPlaylistUserValidateBeforeCall(playlistId, userId, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for getPlaylistUsers + * @param playlistId The playlist id. (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Found shares. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call getPlaylistUsersCall(UUID playlistId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Playlists/{playlistId}/Users" + .replace("{" + "playlistId" + "}", localVarApiClient.escapeString(playlistId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getPlaylistUsersValidateBeforeCall(UUID playlistId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'playlistId' is set + if (playlistId == null) { + throw new ApiException("Missing the required parameter 'playlistId' when calling getPlaylistUsers(Async)"); + } + + return getPlaylistUsersCall(playlistId, _callback); + + } + + /** + * Get a playlist's users. + * + * @param playlistId The playlist id. (required) + * @return List<PlaylistUserPermissions> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Found shares. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public List getPlaylistUsers(UUID playlistId) throws ApiException { + ApiResponse> localVarResp = getPlaylistUsersWithHttpInfo(playlistId); + return localVarResp.getData(); + } + + /** + * Get a playlist's users. + * + * @param playlistId The playlist id. (required) + * @return ApiResponse<List<PlaylistUserPermissions>> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Found shares. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public ApiResponse> getPlaylistUsersWithHttpInfo(UUID playlistId) throws ApiException { + okhttp3.Call localVarCall = getPlaylistUsersValidateBeforeCall(playlistId, null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Get a playlist's users. (asynchronously) + * + * @param playlistId The playlist id. (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Found shares. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call getPlaylistUsersAsync(UUID playlistId, final ApiCallback> _callback) throws ApiException { + + okhttp3.Call localVarCall = getPlaylistUsersValidateBeforeCall(playlistId, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for moveItem + * @param playlistId The playlist id. (required) + * @param itemId The item id. (required) + * @param newIndex The new index. (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Item moved to new index. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call moveItemCall(String playlistId, String itemId, Integer newIndex, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Playlists/{playlistId}/Items/{itemId}/Move/{newIndex}" + .replace("{" + "playlistId" + "}", localVarApiClient.escapeString(playlistId.toString())) + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())) + .replace("{" + "newIndex" + "}", localVarApiClient.escapeString(newIndex.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call moveItemValidateBeforeCall(String playlistId, String itemId, Integer newIndex, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'playlistId' is set + if (playlistId == null) { + throw new ApiException("Missing the required parameter 'playlistId' when calling moveItem(Async)"); + } + + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling moveItem(Async)"); + } + + // verify the required parameter 'newIndex' is set + if (newIndex == null) { + throw new ApiException("Missing the required parameter 'newIndex' when calling moveItem(Async)"); + } + + return moveItemCall(playlistId, itemId, newIndex, _callback); + + } + + /** + * Moves a playlist item. + * + * @param playlistId The playlist id. (required) + * @param itemId The item id. (required) + * @param newIndex The new index. (required) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Item moved to new index. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public void moveItem(String playlistId, String itemId, Integer newIndex) throws ApiException { + moveItemWithHttpInfo(playlistId, itemId, newIndex); + } + + /** + * Moves a playlist item. + * + * @param playlistId The playlist id. (required) + * @param itemId The item id. (required) + * @param newIndex The new index. (required) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Item moved to new index. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public ApiResponse moveItemWithHttpInfo(String playlistId, String itemId, Integer newIndex) throws ApiException { + okhttp3.Call localVarCall = moveItemValidateBeforeCall(playlistId, itemId, newIndex, null); + return localVarApiClient.execute(localVarCall); + } + + /** + * Moves a playlist item. (asynchronously) + * + * @param playlistId The playlist id. (required) + * @param itemId The item id. (required) + * @param newIndex The new index. (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Item moved to new index. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call moveItemAsync(String playlistId, String itemId, Integer newIndex, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = moveItemValidateBeforeCall(playlistId, itemId, newIndex, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); + return localVarCall; + } + /** + * Build call for removeItemFromPlaylist + * @param playlistId The playlist id. (required) + * @param entryIds The item ids, comma delimited. (optional) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Items removed. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call removeItemFromPlaylistCall(String playlistId, List entryIds, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Playlists/{playlistId}/Items" + .replace("{" + "playlistId" + "}", localVarApiClient.escapeString(playlistId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (entryIds != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "entryIds", entryIds)); + } + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call removeItemFromPlaylistValidateBeforeCall(String playlistId, List entryIds, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'playlistId' is set + if (playlistId == null) { + throw new ApiException("Missing the required parameter 'playlistId' when calling removeItemFromPlaylist(Async)"); + } + + return removeItemFromPlaylistCall(playlistId, entryIds, _callback); + + } + + /** + * Removes items from a playlist. + * + * @param playlistId The playlist id. (required) + * @param entryIds The item ids, comma delimited. (optional) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Items removed. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public void removeItemFromPlaylist(String playlistId, List entryIds) throws ApiException { + removeItemFromPlaylistWithHttpInfo(playlistId, entryIds); + } + + /** + * Removes items from a playlist. + * + * @param playlistId The playlist id. (required) + * @param entryIds The item ids, comma delimited. (optional) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Items removed. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public ApiResponse removeItemFromPlaylistWithHttpInfo(String playlistId, List entryIds) throws ApiException { + okhttp3.Call localVarCall = removeItemFromPlaylistValidateBeforeCall(playlistId, entryIds, null); + return localVarApiClient.execute(localVarCall); + } + + /** + * Removes items from a playlist. (asynchronously) + * + * @param playlistId The playlist id. (required) + * @param entryIds The item ids, comma delimited. (optional) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Items removed. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call removeItemFromPlaylistAsync(String playlistId, List entryIds, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = removeItemFromPlaylistValidateBeforeCall(playlistId, entryIds, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); + return localVarCall; + } + /** + * Build call for removeUserFromPlaylist + * @param playlistId The playlist id. (required) + * @param userId The user id. (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 User permissions removed from playlist. -
403 Forbidden -
404 No playlist or user permissions found. -
401 Unauthorized access. -
+ */ + public okhttp3.Call removeUserFromPlaylistCall(UUID playlistId, UUID userId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Playlists/{playlistId}/Users/{userId}" + .replace("{" + "playlistId" + "}", localVarApiClient.escapeString(playlistId.toString())) + .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call removeUserFromPlaylistValidateBeforeCall(UUID playlistId, UUID userId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'playlistId' is set + if (playlistId == null) { + throw new ApiException("Missing the required parameter 'playlistId' when calling removeUserFromPlaylist(Async)"); + } + + // verify the required parameter 'userId' is set + if (userId == null) { + throw new ApiException("Missing the required parameter 'userId' when calling removeUserFromPlaylist(Async)"); + } + + return removeUserFromPlaylistCall(playlistId, userId, _callback); + + } + + /** + * Remove a user from a playlist's users. + * + * @param playlistId The playlist id. (required) + * @param userId The user id. (required) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 User permissions removed from playlist. -
403 Forbidden -
404 No playlist or user permissions found. -
401 Unauthorized access. -
+ */ + public void removeUserFromPlaylist(UUID playlistId, UUID userId) throws ApiException { + removeUserFromPlaylistWithHttpInfo(playlistId, userId); + } + + /** + * Remove a user from a playlist's users. + * + * @param playlistId The playlist id. (required) + * @param userId The user id. (required) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 User permissions removed from playlist. -
403 Forbidden -
404 No playlist or user permissions found. -
401 Unauthorized access. -
+ */ + public ApiResponse removeUserFromPlaylistWithHttpInfo(UUID playlistId, UUID userId) throws ApiException { + okhttp3.Call localVarCall = removeUserFromPlaylistValidateBeforeCall(playlistId, userId, null); + return localVarApiClient.execute(localVarCall); + } + + /** + * Remove a user from a playlist's users. (asynchronously) + * + * @param playlistId The playlist id. (required) + * @param userId The user id. (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 User permissions removed from playlist. -
403 Forbidden -
404 No playlist or user permissions found. -
401 Unauthorized access. -
+ */ + public okhttp3.Call removeUserFromPlaylistAsync(UUID playlistId, UUID userId, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = removeUserFromPlaylistValidateBeforeCall(playlistId, userId, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); + return localVarCall; + } + /** + * Build call for updatePlaylist + * @param playlistId The playlist id. (required) + * @param updatePlaylistDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id. (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Playlist updated. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call updatePlaylistCall(UUID playlistId, UpdatePlaylistDto updatePlaylistDto, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = updatePlaylistDto; + + // create path and map variables + String localVarPath = "/Playlists/{playlistId}" + .replace("{" + "playlistId" + "}", localVarApiClient.escapeString(playlistId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json", + "text/json", + "application/*+json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call updatePlaylistValidateBeforeCall(UUID playlistId, UpdatePlaylistDto updatePlaylistDto, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'playlistId' is set + if (playlistId == null) { + throw new ApiException("Missing the required parameter 'playlistId' when calling updatePlaylist(Async)"); + } + + // verify the required parameter 'updatePlaylistDto' is set + if (updatePlaylistDto == null) { + throw new ApiException("Missing the required parameter 'updatePlaylistDto' when calling updatePlaylist(Async)"); + } + + return updatePlaylistCall(playlistId, updatePlaylistDto, _callback); + + } + + /** + * Updates a playlist. + * + * @param playlistId The playlist id. (required) + * @param updatePlaylistDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id. (required) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Playlist updated. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public void updatePlaylist(UUID playlistId, UpdatePlaylistDto updatePlaylistDto) throws ApiException { + updatePlaylistWithHttpInfo(playlistId, updatePlaylistDto); + } + + /** + * Updates a playlist. + * + * @param playlistId The playlist id. (required) + * @param updatePlaylistDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id. (required) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Playlist updated. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public ApiResponse updatePlaylistWithHttpInfo(UUID playlistId, UpdatePlaylistDto updatePlaylistDto) throws ApiException { + okhttp3.Call localVarCall = updatePlaylistValidateBeforeCall(playlistId, updatePlaylistDto, null); + return localVarApiClient.execute(localVarCall); + } + + /** + * Updates a playlist. (asynchronously) + * + * @param playlistId The playlist id. (required) + * @param updatePlaylistDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id. (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 Playlist updated. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call updatePlaylistAsync(UUID playlistId, UpdatePlaylistDto updatePlaylistDto, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = updatePlaylistValidateBeforeCall(playlistId, updatePlaylistDto, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); + return localVarCall; + } + /** + * Build call for updatePlaylistUser + * @param playlistId The playlist id. (required) + * @param userId The user id. (required) + * @param updatePlaylistUserDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto. (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 User's permissions modified. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call updatePlaylistUserCall(UUID playlistId, UUID userId, UpdatePlaylistUserDto updatePlaylistUserDto, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = updatePlaylistUserDto; + + // create path and map variables + String localVarPath = "/Playlists/{playlistId}/Users/{userId}" + .replace("{" + "playlistId" + "}", localVarApiClient.escapeString(playlistId.toString())) + .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json", + "text/json", + "application/*+json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call updatePlaylistUserValidateBeforeCall(UUID playlistId, UUID userId, UpdatePlaylistUserDto updatePlaylistUserDto, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'playlistId' is set + if (playlistId == null) { + throw new ApiException("Missing the required parameter 'playlistId' when calling updatePlaylistUser(Async)"); + } + + // verify the required parameter 'userId' is set + if (userId == null) { + throw new ApiException("Missing the required parameter 'userId' when calling updatePlaylistUser(Async)"); + } + + // verify the required parameter 'updatePlaylistUserDto' is set + if (updatePlaylistUserDto == null) { + throw new ApiException("Missing the required parameter 'updatePlaylistUserDto' when calling updatePlaylistUser(Async)"); + } + + return updatePlaylistUserCall(playlistId, userId, updatePlaylistUserDto, _callback); + + } + + /** + * Modify a user of a playlist's users. + * + * @param playlistId The playlist id. (required) + * @param userId The user id. (required) + * @param updatePlaylistUserDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto. (required) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 User's permissions modified. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public void updatePlaylistUser(UUID playlistId, UUID userId, UpdatePlaylistUserDto updatePlaylistUserDto) throws ApiException { + updatePlaylistUserWithHttpInfo(playlistId, userId, updatePlaylistUserDto); + } + + /** + * Modify a user of a playlist's users. + * + * @param playlistId The playlist id. (required) + * @param userId The user id. (required) + * @param updatePlaylistUserDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto. (required) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 User's permissions modified. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public ApiResponse updatePlaylistUserWithHttpInfo(UUID playlistId, UUID userId, UpdatePlaylistUserDto updatePlaylistUserDto) throws ApiException { + okhttp3.Call localVarCall = updatePlaylistUserValidateBeforeCall(playlistId, userId, updatePlaylistUserDto, null); + return localVarApiClient.execute(localVarCall); + } + + /** + * Modify a user of a playlist's users. (asynchronously) + * + * @param playlistId The playlist id. (required) + * @param userId The user id. (required) + * @param updatePlaylistUserDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto. (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
204 User's permissions modified. -
403 Access forbidden. -
404 Playlist not found. -
401 Unauthorized -
+ */ + public okhttp3.Call updatePlaylistUserAsync(UUID playlistId, UUID userId, UpdatePlaylistUserDto updatePlaylistUserDto, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = updatePlaylistUserValidateBeforeCall(playlistId, userId, updatePlaylistUserDto, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); + return localVarCall; + } +} diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/PlaystateApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/PlaystateApi.java similarity index 87% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/PlaystateApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/PlaystateApi.java index bb161d0aea1da..0c5163206db6b 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/PlaystateApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/PlaystateApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -32,6 +32,7 @@ import org.openapitools.client.model.PlaybackProgressInfo; import org.openapitools.client.model.PlaybackStartInfo; import org.openapitools.client.model.PlaybackStopInfo; +import org.openapitools.client.model.ProblemDetails; import org.openapitools.client.model.RepeatMode; import java.util.UUID; import org.openapitools.client.model.UserItemDataDto; @@ -81,8 +82,8 @@ public void setCustomBaseUrl(String customBaseUrl) { /** * Build call for markPlayedItem - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param datePlayed Optional. The date the item was played. (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -92,11 +93,12 @@ public void setCustomBaseUrl(String customBaseUrl) { Response Details Status Code Description Response Headers 200 Item marked as played. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call markPlayedItemCall(UUID userId, UUID itemId, OffsetDateTime datePlayed, final ApiCallback _callback) throws ApiException { + public okhttp3.Call markPlayedItemCall(UUID itemId, UUID userId, OffsetDateTime datePlayed, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -113,8 +115,7 @@ public okhttp3.Call markPlayedItemCall(UUID userId, UUID itemId, OffsetDateTime Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/PlayedItems/{itemId}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) + String localVarPath = "/UserPlayedItems/{itemId}" .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); @@ -123,6 +124,10 @@ public okhttp3.Call markPlayedItemCall(UUID userId, UUID itemId, OffsetDateTime Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + if (datePlayed != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("datePlayed", datePlayed)); } @@ -149,26 +154,21 @@ public okhttp3.Call markPlayedItemCall(UUID userId, UUID itemId, OffsetDateTime } @SuppressWarnings("rawtypes") - private okhttp3.Call markPlayedItemValidateBeforeCall(UUID userId, UUID itemId, OffsetDateTime datePlayed, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling markPlayedItem(Async)"); - } - + private okhttp3.Call markPlayedItemValidateBeforeCall(UUID itemId, UUID userId, OffsetDateTime datePlayed, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling markPlayedItem(Async)"); } - return markPlayedItemCall(userId, itemId, datePlayed, _callback); + return markPlayedItemCall(itemId, userId, datePlayed, _callback); } /** * Marks an item as played for user. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param datePlayed Optional. The date the item was played. (optional) * @return UserItemDataDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -177,20 +177,21 @@ private okhttp3.Call markPlayedItemValidateBeforeCall(UUID userId, UUID itemId, Response Details Status Code Description Response Headers 200 Item marked as played. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public UserItemDataDto markPlayedItem(UUID userId, UUID itemId, OffsetDateTime datePlayed) throws ApiException { - ApiResponse localVarResp = markPlayedItemWithHttpInfo(userId, itemId, datePlayed); + public UserItemDataDto markPlayedItem(UUID itemId, UUID userId, OffsetDateTime datePlayed) throws ApiException { + ApiResponse localVarResp = markPlayedItemWithHttpInfo(itemId, userId, datePlayed); return localVarResp.getData(); } /** * Marks an item as played for user. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param datePlayed Optional. The date the item was played. (optional) * @return ApiResponse<UserItemDataDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -199,12 +200,13 @@ public UserItemDataDto markPlayedItem(UUID userId, UUID itemId, OffsetDateTime d Response Details Status Code Description Response Headers 200 Item marked as played. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public ApiResponse markPlayedItemWithHttpInfo(UUID userId, UUID itemId, OffsetDateTime datePlayed) throws ApiException { - okhttp3.Call localVarCall = markPlayedItemValidateBeforeCall(userId, itemId, datePlayed, null); + public ApiResponse markPlayedItemWithHttpInfo(UUID itemId, UUID userId, OffsetDateTime datePlayed) throws ApiException { + okhttp3.Call localVarCall = markPlayedItemValidateBeforeCall(itemId, userId, datePlayed, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -212,8 +214,8 @@ public ApiResponse markPlayedItemWithHttpInfo(UUID userId, UUID /** * Marks an item as played for user. (asynchronously) * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param datePlayed Optional. The date the item was played. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -223,21 +225,22 @@ public ApiResponse markPlayedItemWithHttpInfo(UUID userId, UUID Response Details Status Code Description Response Headers 200 Item marked as played. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call markPlayedItemAsync(UUID userId, UUID itemId, OffsetDateTime datePlayed, final ApiCallback _callback) throws ApiException { + public okhttp3.Call markPlayedItemAsync(UUID itemId, UUID userId, OffsetDateTime datePlayed, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = markPlayedItemValidateBeforeCall(userId, itemId, datePlayed, _callback); + okhttp3.Call localVarCall = markPlayedItemValidateBeforeCall(itemId, userId, datePlayed, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for markUnplayedItem - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -246,11 +249,12 @@ public okhttp3.Call markPlayedItemAsync(UUID userId, UUID itemId, OffsetDateTime Response Details Status Code Description Response Headers 200 Item marked as unplayed. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call markUnplayedItemCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call markUnplayedItemCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -267,8 +271,7 @@ public okhttp3.Call markUnplayedItemCall(UUID userId, UUID itemId, final ApiCall Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/PlayedItems/{itemId}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) + String localVarPath = "/UserPlayedItems/{itemId}" .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); @@ -277,6 +280,10 @@ public okhttp3.Call markUnplayedItemCall(UUID userId, UUID itemId, final ApiCall Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -299,26 +306,21 @@ public okhttp3.Call markUnplayedItemCall(UUID userId, UUID itemId, final ApiCall } @SuppressWarnings("rawtypes") - private okhttp3.Call markUnplayedItemValidateBeforeCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling markUnplayedItem(Async)"); - } - + private okhttp3.Call markUnplayedItemValidateBeforeCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling markUnplayedItem(Async)"); } - return markUnplayedItemCall(userId, itemId, _callback); + return markUnplayedItemCall(itemId, userId, _callback); } /** * Marks an item as unplayed for user. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return UserItemDataDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -326,20 +328,21 @@ private okhttp3.Call markUnplayedItemValidateBeforeCall(UUID userId, UUID itemId Response Details Status Code Description Response Headers 200 Item marked as unplayed. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public UserItemDataDto markUnplayedItem(UUID userId, UUID itemId) throws ApiException { - ApiResponse localVarResp = markUnplayedItemWithHttpInfo(userId, itemId); + public UserItemDataDto markUnplayedItem(UUID itemId, UUID userId) throws ApiException { + ApiResponse localVarResp = markUnplayedItemWithHttpInfo(itemId, userId); return localVarResp.getData(); } /** * Marks an item as unplayed for user. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return ApiResponse<UserItemDataDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -347,12 +350,13 @@ public UserItemDataDto markUnplayedItem(UUID userId, UUID itemId) throws ApiExce Response Details Status Code Description Response Headers 200 Item marked as unplayed. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public ApiResponse markUnplayedItemWithHttpInfo(UUID userId, UUID itemId) throws ApiException { - okhttp3.Call localVarCall = markUnplayedItemValidateBeforeCall(userId, itemId, null); + public ApiResponse markUnplayedItemWithHttpInfo(UUID itemId, UUID userId) throws ApiException { + okhttp3.Call localVarCall = markUnplayedItemValidateBeforeCall(itemId, userId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -360,8 +364,8 @@ public ApiResponse markUnplayedItemWithHttpInfo(UUID userId, UU /** * Marks an item as unplayed for user. (asynchronously) * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -370,20 +374,20 @@ public ApiResponse markUnplayedItemWithHttpInfo(UUID userId, UU Response Details Status Code Description Response Headers 200 Item marked as unplayed. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call markUnplayedItemAsync(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call markUnplayedItemAsync(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = markUnplayedItemValidateBeforeCall(userId, itemId, _callback); + okhttp3.Call localVarCall = markUnplayedItemValidateBeforeCall(itemId, userId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for onPlaybackProgress - * @param userId User id. (required) * @param itemId Item id. (required) * @param mediaSourceId The id of the MediaSource. (optional) * @param positionTicks Optional. The current position, in ticks. 1 tick = 10000 ms. (optional) @@ -408,7 +412,7 @@ public okhttp3.Call markUnplayedItemAsync(UUID userId, UUID itemId, final ApiCal 403 Forbidden - */ - public okhttp3.Call onPlaybackProgressCall(UUID userId, UUID itemId, String mediaSourceId, Long positionTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer volumeLevel, PlayMethod playMethod, String liveStreamId, String playSessionId, RepeatMode repeatMode, Boolean isPaused, Boolean isMuted, final ApiCallback _callback) throws ApiException { + public okhttp3.Call onPlaybackProgressCall(UUID itemId, String mediaSourceId, Long positionTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer volumeLevel, PlayMethod playMethod, String liveStreamId, String playSessionId, RepeatMode repeatMode, Boolean isPaused, Boolean isMuted, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -425,8 +429,7 @@ public okhttp3.Call onPlaybackProgressCall(UUID userId, UUID itemId, String medi Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/PlayingItems/{itemId}/Progress" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) + String localVarPath = "/PlayingItems/{itemId}/Progress" .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); @@ -498,25 +501,19 @@ public okhttp3.Call onPlaybackProgressCall(UUID userId, UUID itemId, String medi } @SuppressWarnings("rawtypes") - private okhttp3.Call onPlaybackProgressValidateBeforeCall(UUID userId, UUID itemId, String mediaSourceId, Long positionTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer volumeLevel, PlayMethod playMethod, String liveStreamId, String playSessionId, RepeatMode repeatMode, Boolean isPaused, Boolean isMuted, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling onPlaybackProgress(Async)"); - } - + private okhttp3.Call onPlaybackProgressValidateBeforeCall(UUID itemId, String mediaSourceId, Long positionTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer volumeLevel, PlayMethod playMethod, String liveStreamId, String playSessionId, RepeatMode repeatMode, Boolean isPaused, Boolean isMuted, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling onPlaybackProgress(Async)"); } - return onPlaybackProgressCall(userId, itemId, mediaSourceId, positionTicks, audioStreamIndex, subtitleStreamIndex, volumeLevel, playMethod, liveStreamId, playSessionId, repeatMode, isPaused, isMuted, _callback); + return onPlaybackProgressCall(itemId, mediaSourceId, positionTicks, audioStreamIndex, subtitleStreamIndex, volumeLevel, playMethod, liveStreamId, playSessionId, repeatMode, isPaused, isMuted, _callback); } /** - * Reports a user's playback progress. + * Reports a session's playback progress. * - * @param userId User id. (required) * @param itemId Item id. (required) * @param mediaSourceId The id of the MediaSource. (optional) * @param positionTicks Optional. The current position, in ticks. 1 tick = 10000 ms. (optional) @@ -539,14 +536,13 @@ private okhttp3.Call onPlaybackProgressValidateBeforeCall(UUID userId, UUID item 403 Forbidden - */ - public void onPlaybackProgress(UUID userId, UUID itemId, String mediaSourceId, Long positionTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer volumeLevel, PlayMethod playMethod, String liveStreamId, String playSessionId, RepeatMode repeatMode, Boolean isPaused, Boolean isMuted) throws ApiException { - onPlaybackProgressWithHttpInfo(userId, itemId, mediaSourceId, positionTicks, audioStreamIndex, subtitleStreamIndex, volumeLevel, playMethod, liveStreamId, playSessionId, repeatMode, isPaused, isMuted); + public void onPlaybackProgress(UUID itemId, String mediaSourceId, Long positionTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer volumeLevel, PlayMethod playMethod, String liveStreamId, String playSessionId, RepeatMode repeatMode, Boolean isPaused, Boolean isMuted) throws ApiException { + onPlaybackProgressWithHttpInfo(itemId, mediaSourceId, positionTicks, audioStreamIndex, subtitleStreamIndex, volumeLevel, playMethod, liveStreamId, playSessionId, repeatMode, isPaused, isMuted); } /** - * Reports a user's playback progress. + * Reports a session's playback progress. * - * @param userId User id. (required) * @param itemId Item id. (required) * @param mediaSourceId The id of the MediaSource. (optional) * @param positionTicks Optional. The current position, in ticks. 1 tick = 10000 ms. (optional) @@ -570,15 +566,14 @@ public void onPlaybackProgress(UUID userId, UUID itemId, String mediaSourceId, L 403 Forbidden - */ - public ApiResponse onPlaybackProgressWithHttpInfo(UUID userId, UUID itemId, String mediaSourceId, Long positionTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer volumeLevel, PlayMethod playMethod, String liveStreamId, String playSessionId, RepeatMode repeatMode, Boolean isPaused, Boolean isMuted) throws ApiException { - okhttp3.Call localVarCall = onPlaybackProgressValidateBeforeCall(userId, itemId, mediaSourceId, positionTicks, audioStreamIndex, subtitleStreamIndex, volumeLevel, playMethod, liveStreamId, playSessionId, repeatMode, isPaused, isMuted, null); + public ApiResponse onPlaybackProgressWithHttpInfo(UUID itemId, String mediaSourceId, Long positionTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer volumeLevel, PlayMethod playMethod, String liveStreamId, String playSessionId, RepeatMode repeatMode, Boolean isPaused, Boolean isMuted) throws ApiException { + okhttp3.Call localVarCall = onPlaybackProgressValidateBeforeCall(itemId, mediaSourceId, positionTicks, audioStreamIndex, subtitleStreamIndex, volumeLevel, playMethod, liveStreamId, playSessionId, repeatMode, isPaused, isMuted, null); return localVarApiClient.execute(localVarCall); } /** - * Reports a user's playback progress. (asynchronously) + * Reports a session's playback progress. (asynchronously) * - * @param userId User id. (required) * @param itemId Item id. (required) * @param mediaSourceId The id of the MediaSource. (optional) * @param positionTicks Optional. The current position, in ticks. 1 tick = 10000 ms. (optional) @@ -603,15 +598,14 @@ public ApiResponse onPlaybackProgressWithHttpInfo(UUID userId, UUID itemId 403 Forbidden - */ - public okhttp3.Call onPlaybackProgressAsync(UUID userId, UUID itemId, String mediaSourceId, Long positionTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer volumeLevel, PlayMethod playMethod, String liveStreamId, String playSessionId, RepeatMode repeatMode, Boolean isPaused, Boolean isMuted, final ApiCallback _callback) throws ApiException { + public okhttp3.Call onPlaybackProgressAsync(UUID itemId, String mediaSourceId, Long positionTicks, Integer audioStreamIndex, Integer subtitleStreamIndex, Integer volumeLevel, PlayMethod playMethod, String liveStreamId, String playSessionId, RepeatMode repeatMode, Boolean isPaused, Boolean isMuted, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = onPlaybackProgressValidateBeforeCall(userId, itemId, mediaSourceId, positionTicks, audioStreamIndex, subtitleStreamIndex, volumeLevel, playMethod, liveStreamId, playSessionId, repeatMode, isPaused, isMuted, _callback); + okhttp3.Call localVarCall = onPlaybackProgressValidateBeforeCall(itemId, mediaSourceId, positionTicks, audioStreamIndex, subtitleStreamIndex, volumeLevel, playMethod, liveStreamId, playSessionId, repeatMode, isPaused, isMuted, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } /** * Build call for onPlaybackStart - * @param userId User id. (required) * @param itemId Item id. (required) * @param mediaSourceId The id of the MediaSource. (optional) * @param audioStreamIndex The audio stream index. (optional) @@ -632,7 +626,7 @@ public okhttp3.Call onPlaybackProgressAsync(UUID userId, UUID itemId, String med 403 Forbidden - */ - public okhttp3.Call onPlaybackStartCall(UUID userId, UUID itemId, String mediaSourceId, Integer audioStreamIndex, Integer subtitleStreamIndex, PlayMethod playMethod, String liveStreamId, String playSessionId, Boolean canSeek, final ApiCallback _callback) throws ApiException { + public okhttp3.Call onPlaybackStartCall(UUID itemId, String mediaSourceId, Integer audioStreamIndex, Integer subtitleStreamIndex, PlayMethod playMethod, String liveStreamId, String playSessionId, Boolean canSeek, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -649,8 +643,7 @@ public okhttp3.Call onPlaybackStartCall(UUID userId, UUID itemId, String mediaSo Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/PlayingItems/{itemId}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) + String localVarPath = "/PlayingItems/{itemId}" .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); @@ -706,25 +699,19 @@ public okhttp3.Call onPlaybackStartCall(UUID userId, UUID itemId, String mediaSo } @SuppressWarnings("rawtypes") - private okhttp3.Call onPlaybackStartValidateBeforeCall(UUID userId, UUID itemId, String mediaSourceId, Integer audioStreamIndex, Integer subtitleStreamIndex, PlayMethod playMethod, String liveStreamId, String playSessionId, Boolean canSeek, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling onPlaybackStart(Async)"); - } - + private okhttp3.Call onPlaybackStartValidateBeforeCall(UUID itemId, String mediaSourceId, Integer audioStreamIndex, Integer subtitleStreamIndex, PlayMethod playMethod, String liveStreamId, String playSessionId, Boolean canSeek, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling onPlaybackStart(Async)"); } - return onPlaybackStartCall(userId, itemId, mediaSourceId, audioStreamIndex, subtitleStreamIndex, playMethod, liveStreamId, playSessionId, canSeek, _callback); + return onPlaybackStartCall(itemId, mediaSourceId, audioStreamIndex, subtitleStreamIndex, playMethod, liveStreamId, playSessionId, canSeek, _callback); } /** - * Reports that a user has begun playing an item. + * Reports that a session has begun playing an item. * - * @param userId User id. (required) * @param itemId Item id. (required) * @param mediaSourceId The id of the MediaSource. (optional) * @param audioStreamIndex The audio stream index. (optional) @@ -743,14 +730,13 @@ private okhttp3.Call onPlaybackStartValidateBeforeCall(UUID userId, UUID itemId, 403 Forbidden - */ - public void onPlaybackStart(UUID userId, UUID itemId, String mediaSourceId, Integer audioStreamIndex, Integer subtitleStreamIndex, PlayMethod playMethod, String liveStreamId, String playSessionId, Boolean canSeek) throws ApiException { - onPlaybackStartWithHttpInfo(userId, itemId, mediaSourceId, audioStreamIndex, subtitleStreamIndex, playMethod, liveStreamId, playSessionId, canSeek); + public void onPlaybackStart(UUID itemId, String mediaSourceId, Integer audioStreamIndex, Integer subtitleStreamIndex, PlayMethod playMethod, String liveStreamId, String playSessionId, Boolean canSeek) throws ApiException { + onPlaybackStartWithHttpInfo(itemId, mediaSourceId, audioStreamIndex, subtitleStreamIndex, playMethod, liveStreamId, playSessionId, canSeek); } /** - * Reports that a user has begun playing an item. + * Reports that a session has begun playing an item. * - * @param userId User id. (required) * @param itemId Item id. (required) * @param mediaSourceId The id of the MediaSource. (optional) * @param audioStreamIndex The audio stream index. (optional) @@ -770,15 +756,14 @@ public void onPlaybackStart(UUID userId, UUID itemId, String mediaSourceId, Inte 403 Forbidden - */ - public ApiResponse onPlaybackStartWithHttpInfo(UUID userId, UUID itemId, String mediaSourceId, Integer audioStreamIndex, Integer subtitleStreamIndex, PlayMethod playMethod, String liveStreamId, String playSessionId, Boolean canSeek) throws ApiException { - okhttp3.Call localVarCall = onPlaybackStartValidateBeforeCall(userId, itemId, mediaSourceId, audioStreamIndex, subtitleStreamIndex, playMethod, liveStreamId, playSessionId, canSeek, null); + public ApiResponse onPlaybackStartWithHttpInfo(UUID itemId, String mediaSourceId, Integer audioStreamIndex, Integer subtitleStreamIndex, PlayMethod playMethod, String liveStreamId, String playSessionId, Boolean canSeek) throws ApiException { + okhttp3.Call localVarCall = onPlaybackStartValidateBeforeCall(itemId, mediaSourceId, audioStreamIndex, subtitleStreamIndex, playMethod, liveStreamId, playSessionId, canSeek, null); return localVarApiClient.execute(localVarCall); } /** - * Reports that a user has begun playing an item. (asynchronously) + * Reports that a session has begun playing an item. (asynchronously) * - * @param userId User id. (required) * @param itemId Item id. (required) * @param mediaSourceId The id of the MediaSource. (optional) * @param audioStreamIndex The audio stream index. (optional) @@ -799,15 +784,14 @@ public ApiResponse onPlaybackStartWithHttpInfo(UUID userId, UUID itemId, S 403 Forbidden - */ - public okhttp3.Call onPlaybackStartAsync(UUID userId, UUID itemId, String mediaSourceId, Integer audioStreamIndex, Integer subtitleStreamIndex, PlayMethod playMethod, String liveStreamId, String playSessionId, Boolean canSeek, final ApiCallback _callback) throws ApiException { + public okhttp3.Call onPlaybackStartAsync(UUID itemId, String mediaSourceId, Integer audioStreamIndex, Integer subtitleStreamIndex, PlayMethod playMethod, String liveStreamId, String playSessionId, Boolean canSeek, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = onPlaybackStartValidateBeforeCall(userId, itemId, mediaSourceId, audioStreamIndex, subtitleStreamIndex, playMethod, liveStreamId, playSessionId, canSeek, _callback); + okhttp3.Call localVarCall = onPlaybackStartValidateBeforeCall(itemId, mediaSourceId, audioStreamIndex, subtitleStreamIndex, playMethod, liveStreamId, playSessionId, canSeek, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } /** * Build call for onPlaybackStopped - * @param userId User id. (required) * @param itemId Item id. (required) * @param mediaSourceId The id of the MediaSource. (optional) * @param nextMediaType The next media type that will play. (optional) @@ -826,7 +810,7 @@ public okhttp3.Call onPlaybackStartAsync(UUID userId, UUID itemId, String mediaS 403 Forbidden - */ - public okhttp3.Call onPlaybackStoppedCall(UUID userId, UUID itemId, String mediaSourceId, String nextMediaType, Long positionTicks, String liveStreamId, String playSessionId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call onPlaybackStoppedCall(UUID itemId, String mediaSourceId, String nextMediaType, Long positionTicks, String liveStreamId, String playSessionId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -843,8 +827,7 @@ public okhttp3.Call onPlaybackStoppedCall(UUID userId, UUID itemId, String media Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/PlayingItems/{itemId}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) + String localVarPath = "/PlayingItems/{itemId}" .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); @@ -892,25 +875,19 @@ public okhttp3.Call onPlaybackStoppedCall(UUID userId, UUID itemId, String media } @SuppressWarnings("rawtypes") - private okhttp3.Call onPlaybackStoppedValidateBeforeCall(UUID userId, UUID itemId, String mediaSourceId, String nextMediaType, Long positionTicks, String liveStreamId, String playSessionId, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling onPlaybackStopped(Async)"); - } - + private okhttp3.Call onPlaybackStoppedValidateBeforeCall(UUID itemId, String mediaSourceId, String nextMediaType, Long positionTicks, String liveStreamId, String playSessionId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling onPlaybackStopped(Async)"); } - return onPlaybackStoppedCall(userId, itemId, mediaSourceId, nextMediaType, positionTicks, liveStreamId, playSessionId, _callback); + return onPlaybackStoppedCall(itemId, mediaSourceId, nextMediaType, positionTicks, liveStreamId, playSessionId, _callback); } /** - * Reports that a user has stopped playing an item. + * Reports that a session has stopped playing an item. * - * @param userId User id. (required) * @param itemId Item id. (required) * @param mediaSourceId The id of the MediaSource. (optional) * @param nextMediaType The next media type that will play. (optional) @@ -927,14 +904,13 @@ private okhttp3.Call onPlaybackStoppedValidateBeforeCall(UUID userId, UUID itemI 403 Forbidden - */ - public void onPlaybackStopped(UUID userId, UUID itemId, String mediaSourceId, String nextMediaType, Long positionTicks, String liveStreamId, String playSessionId) throws ApiException { - onPlaybackStoppedWithHttpInfo(userId, itemId, mediaSourceId, nextMediaType, positionTicks, liveStreamId, playSessionId); + public void onPlaybackStopped(UUID itemId, String mediaSourceId, String nextMediaType, Long positionTicks, String liveStreamId, String playSessionId) throws ApiException { + onPlaybackStoppedWithHttpInfo(itemId, mediaSourceId, nextMediaType, positionTicks, liveStreamId, playSessionId); } /** - * Reports that a user has stopped playing an item. + * Reports that a session has stopped playing an item. * - * @param userId User id. (required) * @param itemId Item id. (required) * @param mediaSourceId The id of the MediaSource. (optional) * @param nextMediaType The next media type that will play. (optional) @@ -952,15 +928,14 @@ public void onPlaybackStopped(UUID userId, UUID itemId, String mediaSourceId, St 403 Forbidden - */ - public ApiResponse onPlaybackStoppedWithHttpInfo(UUID userId, UUID itemId, String mediaSourceId, String nextMediaType, Long positionTicks, String liveStreamId, String playSessionId) throws ApiException { - okhttp3.Call localVarCall = onPlaybackStoppedValidateBeforeCall(userId, itemId, mediaSourceId, nextMediaType, positionTicks, liveStreamId, playSessionId, null); + public ApiResponse onPlaybackStoppedWithHttpInfo(UUID itemId, String mediaSourceId, String nextMediaType, Long positionTicks, String liveStreamId, String playSessionId) throws ApiException { + okhttp3.Call localVarCall = onPlaybackStoppedValidateBeforeCall(itemId, mediaSourceId, nextMediaType, positionTicks, liveStreamId, playSessionId, null); return localVarApiClient.execute(localVarCall); } /** - * Reports that a user has stopped playing an item. (asynchronously) + * Reports that a session has stopped playing an item. (asynchronously) * - * @param userId User id. (required) * @param itemId Item id. (required) * @param mediaSourceId The id of the MediaSource. (optional) * @param nextMediaType The next media type that will play. (optional) @@ -979,9 +954,9 @@ public ApiResponse onPlaybackStoppedWithHttpInfo(UUID userId, UUID itemId, 403 Forbidden - */ - public okhttp3.Call onPlaybackStoppedAsync(UUID userId, UUID itemId, String mediaSourceId, String nextMediaType, Long positionTicks, String liveStreamId, String playSessionId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call onPlaybackStoppedAsync(UUID itemId, String mediaSourceId, String nextMediaType, Long positionTicks, String liveStreamId, String playSessionId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = onPlaybackStoppedValidateBeforeCall(userId, itemId, mediaSourceId, nextMediaType, positionTicks, liveStreamId, playSessionId, _callback); + okhttp3.Call localVarCall = onPlaybackStoppedValidateBeforeCall(itemId, mediaSourceId, nextMediaType, positionTicks, liveStreamId, playSessionId, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/PluginsApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/PluginsApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/PluginsApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/PluginsApi.java index b3901e178cf35..a104af338b3e7 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/PluginsApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/PluginsApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/QuickConnectApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/QuickConnectApi.java similarity index 83% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/QuickConnectApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/QuickConnectApi.java index fd667f908adcc..2c411ea0b2995 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/QuickConnectApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/QuickConnectApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -29,6 +29,7 @@ import org.openapitools.client.model.ProblemDetails; import org.openapitools.client.model.QuickConnectResult; +import java.util.UUID; import java.lang.reflect.Type; import java.util.ArrayList; @@ -74,8 +75,9 @@ public void setCustomBaseUrl(String customBaseUrl) { } /** - * Build call for authorize + * Build call for authorizeQuickConnect * @param code Quick connect code to authorize. (required) + * @param userId The user the authorize. Access to the requested user is required. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -88,7 +90,7 @@ public void setCustomBaseUrl(String customBaseUrl) { 401 Unauthorized - */ - public okhttp3.Call authorizeCall(String code, final ApiCallback _callback) throws ApiException { + public okhttp3.Call authorizeQuickConnectCall(String code, UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -117,6 +119,10 @@ public okhttp3.Call authorizeCall(String code, final ApiCallback _callback) thro localVarQueryParams.addAll(localVarApiClient.parameterToPair("code", code)); } + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -139,13 +145,13 @@ public okhttp3.Call authorizeCall(String code, final ApiCallback _callback) thro } @SuppressWarnings("rawtypes") - private okhttp3.Call authorizeValidateBeforeCall(String code, final ApiCallback _callback) throws ApiException { + private okhttp3.Call authorizeQuickConnectValidateBeforeCall(String code, UUID userId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'code' is set if (code == null) { - throw new ApiException("Missing the required parameter 'code' when calling authorize(Async)"); + throw new ApiException("Missing the required parameter 'code' when calling authorizeQuickConnect(Async)"); } - return authorizeCall(code, _callback); + return authorizeQuickConnectCall(code, userId, _callback); } @@ -153,6 +159,7 @@ private okhttp3.Call authorizeValidateBeforeCall(String code, final ApiCallback * Authorizes a pending quick connect request. * * @param code Quick connect code to authorize. (required) + * @param userId The user the authorize. Access to the requested user is required. (optional) * @return Boolean * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -164,8 +171,8 @@ private okhttp3.Call authorizeValidateBeforeCall(String code, final ApiCallback 401 Unauthorized - */ - public Boolean authorize(String code) throws ApiException { - ApiResponse localVarResp = authorizeWithHttpInfo(code); + public Boolean authorizeQuickConnect(String code, UUID userId) throws ApiException { + ApiResponse localVarResp = authorizeQuickConnectWithHttpInfo(code, userId); return localVarResp.getData(); } @@ -173,6 +180,7 @@ public Boolean authorize(String code) throws ApiException { * Authorizes a pending quick connect request. * * @param code Quick connect code to authorize. (required) + * @param userId The user the authorize. Access to the requested user is required. (optional) * @return ApiResponse<Boolean> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -184,8 +192,8 @@ public Boolean authorize(String code) throws ApiException { 401 Unauthorized - */ - public ApiResponse authorizeWithHttpInfo(String code) throws ApiException { - okhttp3.Call localVarCall = authorizeValidateBeforeCall(code, null); + public ApiResponse authorizeQuickConnectWithHttpInfo(String code, UUID userId) throws ApiException { + okhttp3.Call localVarCall = authorizeQuickConnectValidateBeforeCall(code, userId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -194,6 +202,7 @@ public ApiResponse authorizeWithHttpInfo(String code) throws ApiExcepti * Authorizes a pending quick connect request. (asynchronously) * * @param code Quick connect code to authorize. (required) + * @param userId The user the authorize. Access to the requested user is required. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -206,16 +215,15 @@ public ApiResponse authorizeWithHttpInfo(String code) throws ApiExcepti 401 Unauthorized - */ - public okhttp3.Call authorizeAsync(String code, final ApiCallback _callback) throws ApiException { + public okhttp3.Call authorizeQuickConnectAsync(String code, UUID userId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = authorizeValidateBeforeCall(code, _callback); + okhttp3.Call localVarCall = authorizeQuickConnectValidateBeforeCall(code, userId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for connect - * @param secret Secret previously returned from the Initiate endpoint. (required) + * Build call for getQuickConnectEnabled * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -223,11 +231,10 @@ public okhttp3.Call authorizeAsync(String code, final ApiCallback _call - - +
Response Details
Status Code Description Response Headers
200 Quick connect result returned. -
404 Unknown quick connect secret. -
200 Quick connect state returned. -
*/ - public okhttp3.Call connectCall(String secret, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getQuickConnectEnabledCall(final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -244,7 +251,7 @@ public okhttp3.Call connectCall(String secret, final ApiCallback _callback) thro Object localVarPostBody = null; // create path and map variables - String localVarPath = "/QuickConnect/Connect"; + String localVarPath = "/QuickConnect/Enabled"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -252,10 +259,6 @@ public okhttp3.Call connectCall(String secret, final ApiCallback _callback) thro Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); - if (secret != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("secret", secret)); - } - final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -278,59 +281,49 @@ public okhttp3.Call connectCall(String secret, final ApiCallback _callback) thro } @SuppressWarnings("rawtypes") - private okhttp3.Call connectValidateBeforeCall(String secret, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'secret' is set - if (secret == null) { - throw new ApiException("Missing the required parameter 'secret' when calling connect(Async)"); - } - - return connectCall(secret, _callback); + private okhttp3.Call getQuickConnectEnabledValidateBeforeCall(final ApiCallback _callback) throws ApiException { + return getQuickConnectEnabledCall(_callback); } /** - * Attempts to retrieve authentication information. + * Gets the current quick connect state. * - * @param secret Secret previously returned from the Initiate endpoint. (required) - * @return QuickConnectResult + * @return Boolean * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - - +
Response Details
Status Code Description Response Headers
200 Quick connect result returned. -
404 Unknown quick connect secret. -
200 Quick connect state returned. -
*/ - public QuickConnectResult connect(String secret) throws ApiException { - ApiResponse localVarResp = connectWithHttpInfo(secret); + public Boolean getQuickConnectEnabled() throws ApiException { + ApiResponse localVarResp = getQuickConnectEnabledWithHttpInfo(); return localVarResp.getData(); } /** - * Attempts to retrieve authentication information. + * Gets the current quick connect state. * - * @param secret Secret previously returned from the Initiate endpoint. (required) - * @return ApiResponse<QuickConnectResult> + * @return ApiResponse<Boolean> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - - +
Response Details
Status Code Description Response Headers
200 Quick connect result returned. -
404 Unknown quick connect secret. -
200 Quick connect state returned. -
*/ - public ApiResponse connectWithHttpInfo(String secret) throws ApiException { - okhttp3.Call localVarCall = connectValidateBeforeCall(secret, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse getQuickConnectEnabledWithHttpInfo() throws ApiException { + okhttp3.Call localVarCall = getQuickConnectEnabledValidateBeforeCall(null); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Attempts to retrieve authentication information. (asynchronously) + * Gets the current quick connect state. (asynchronously) * - * @param secret Secret previously returned from the Initiate endpoint. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -338,19 +331,19 @@ public ApiResponse connectWithHttpInfo(String secret) throws - - +
Response Details
Status Code Description Response Headers
200 Quick connect result returned. -
404 Unknown quick connect secret. -
200 Quick connect state returned. -
*/ - public okhttp3.Call connectAsync(String secret, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getQuickConnectEnabledAsync(final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = connectValidateBeforeCall(secret, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + okhttp3.Call localVarCall = getQuickConnectEnabledValidateBeforeCall(_callback); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for getEnabled + * Build call for getQuickConnectState + * @param secret Secret previously returned from the Initiate endpoint. (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -358,10 +351,11 @@ public okhttp3.Call connectAsync(String secret, final ApiCallback Response Details Status Code Description Response Headers - 200 Quick connect state returned. - + 200 Quick connect result returned. - + 404 Unknown quick connect secret. - */ - public okhttp3.Call getEnabledCall(final ApiCallback _callback) throws ApiException { + public okhttp3.Call getQuickConnectStateCall(String secret, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -378,7 +372,7 @@ public okhttp3.Call getEnabledCall(final ApiCallback _callback) throws ApiExcept Object localVarPostBody = null; // create path and map variables - String localVarPath = "/QuickConnect/Enabled"; + String localVarPath = "/QuickConnect/Connect"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -386,6 +380,10 @@ public okhttp3.Call getEnabledCall(final ApiCallback _callback) throws ApiExcept Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (secret != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("secret", secret)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -408,49 +406,59 @@ public okhttp3.Call getEnabledCall(final ApiCallback _callback) throws ApiExcept } @SuppressWarnings("rawtypes") - private okhttp3.Call getEnabledValidateBeforeCall(final ApiCallback _callback) throws ApiException { - return getEnabledCall(_callback); + private okhttp3.Call getQuickConnectStateValidateBeforeCall(String secret, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'secret' is set + if (secret == null) { + throw new ApiException("Missing the required parameter 'secret' when calling getQuickConnectState(Async)"); + } + + return getQuickConnectStateCall(secret, _callback); } /** - * Gets the current quick connect state. + * Attempts to retrieve authentication information. * - * @return Boolean + * @param secret Secret previously returned from the Initiate endpoint. (required) + * @return QuickConnectResult * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - + +
Response Details
Status Code Description Response Headers
200 Quick connect state returned. -
200 Quick connect result returned. -
404 Unknown quick connect secret. -
*/ - public Boolean getEnabled() throws ApiException { - ApiResponse localVarResp = getEnabledWithHttpInfo(); + public QuickConnectResult getQuickConnectState(String secret) throws ApiException { + ApiResponse localVarResp = getQuickConnectStateWithHttpInfo(secret); return localVarResp.getData(); } /** - * Gets the current quick connect state. + * Attempts to retrieve authentication information. * - * @return ApiResponse<Boolean> + * @param secret Secret previously returned from the Initiate endpoint. (required) + * @return ApiResponse<QuickConnectResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - + +
Response Details
Status Code Description Response Headers
200 Quick connect state returned. -
200 Quick connect result returned. -
404 Unknown quick connect secret. -
*/ - public ApiResponse getEnabledWithHttpInfo() throws ApiException { - okhttp3.Call localVarCall = getEnabledValidateBeforeCall(null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse getQuickConnectStateWithHttpInfo(String secret) throws ApiException { + okhttp3.Call localVarCall = getQuickConnectStateValidateBeforeCall(secret, null); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Gets the current quick connect state. (asynchronously) + * Attempts to retrieve authentication information. (asynchronously) * + * @param secret Secret previously returned from the Initiate endpoint. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -458,18 +466,19 @@ public ApiResponse getEnabledWithHttpInfo() throws ApiException { - + +
Response Details
Status Code Description Response Headers
200 Quick connect state returned. -
200 Quick connect result returned. -
404 Unknown quick connect secret. -
*/ - public okhttp3.Call getEnabledAsync(final ApiCallback _callback) throws ApiException { + public okhttp3.Call getQuickConnectStateAsync(String secret, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getEnabledValidateBeforeCall(_callback); - Type localVarReturnType = new TypeToken(){}.getType(); + okhttp3.Call localVarCall = getQuickConnectStateValidateBeforeCall(secret, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for initiate + * Build call for initiateQuickConnect * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -481,7 +490,7 @@ public okhttp3.Call getEnabledAsync(final ApiCallback _callback) throws 401 Quick connect is not active on this server. - */ - public okhttp3.Call initiateCall(final ApiCallback _callback) throws ApiException { + public okhttp3.Call initiateQuickConnectCall(final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -524,12 +533,12 @@ public okhttp3.Call initiateCall(final ApiCallback _callback) throws ApiExceptio } String[] localVarAuthNames = new String[] { }; - return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") - private okhttp3.Call initiateValidateBeforeCall(final ApiCallback _callback) throws ApiException { - return initiateCall(_callback); + private okhttp3.Call initiateQuickConnectValidateBeforeCall(final ApiCallback _callback) throws ApiException { + return initiateQuickConnectCall(_callback); } @@ -546,8 +555,8 @@ private okhttp3.Call initiateValidateBeforeCall(final ApiCallback _callback) thr 401 Quick connect is not active on this server. - */ - public QuickConnectResult initiate() throws ApiException { - ApiResponse localVarResp = initiateWithHttpInfo(); + public QuickConnectResult initiateQuickConnect() throws ApiException { + ApiResponse localVarResp = initiateQuickConnectWithHttpInfo(); return localVarResp.getData(); } @@ -564,8 +573,8 @@ public QuickConnectResult initiate() throws ApiException { 401 Quick connect is not active on this server. - */ - public ApiResponse initiateWithHttpInfo() throws ApiException { - okhttp3.Call localVarCall = initiateValidateBeforeCall(null); + public ApiResponse initiateQuickConnectWithHttpInfo() throws ApiException { + okhttp3.Call localVarCall = initiateQuickConnectValidateBeforeCall(null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -584,9 +593,9 @@ public ApiResponse initiateWithHttpInfo() throws ApiExceptio 401 Quick connect is not active on this server. - */ - public okhttp3.Call initiateAsync(final ApiCallback _callback) throws ApiException { + public okhttp3.Call initiateQuickConnectAsync(final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = initiateValidateBeforeCall(_callback); + okhttp3.Call localVarCall = initiateQuickConnectValidateBeforeCall(_callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/RemoteImageApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/RemoteImageApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/RemoteImageApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/RemoteImageApi.java index 4628254d48513..9c11c4260ed63 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/RemoteImageApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/RemoteImageApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ScheduledTasksApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ScheduledTasksApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ScheduledTasksApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ScheduledTasksApi.java index e7a922a598392..d3bcbae087d1b 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/ScheduledTasksApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/ScheduledTasksApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SearchApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SearchApi.java similarity index 80% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SearchApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SearchApi.java index 022c3de34a538..13a352633dded 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SearchApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SearchApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -28,6 +28,7 @@ import org.openapitools.client.model.BaseItemKind; +import org.openapitools.client.model.MediaType; import org.openapitools.client.model.SearchHintResult; import java.util.UUID; @@ -75,14 +76,14 @@ public void setCustomBaseUrl(String customBaseUrl) { } /** - * Build call for get + * Build call for getSearchHints * @param searchTerm The search term to filter on. (required) * @param startIndex Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param userId Optional. Supply a user id to search within a user's library or omit to search all. (optional) - * @param includeItemTypes If specified, only results with the specified item types are returned. This allows multiple, comma delimeted. (optional) - * @param excludeItemTypes If specified, results with these item types are filtered out. This allows multiple, comma delimeted. (optional) - * @param mediaTypes If specified, only results with the specified media types are returned. This allows multiple, comma delimeted. (optional) + * @param includeItemTypes If specified, only results with the specified item types are returned. This allows multiple, comma delimited. (optional) + * @param excludeItemTypes If specified, results with these item types are filtered out. This allows multiple, comma delimited. (optional) + * @param mediaTypes If specified, only results with the specified media types are returned. This allows multiple, comma delimited. (optional) * @param parentId If specified, only children of the parent are returned. (optional) * @param isMovie Optional filter for movies. (optional) * @param isSeries Optional filter for series. (optional) @@ -106,7 +107,7 @@ public void setCustomBaseUrl(String customBaseUrl) { 403 Forbidden - */ - public okhttp3.Call getCall(String searchTerm, Integer startIndex, Integer limit, UUID userId, List includeItemTypes, List excludeItemTypes, List mediaTypes, UUID parentId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Boolean includePeople, Boolean includeMedia, Boolean includeGenres, Boolean includeStudios, Boolean includeArtists, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getSearchHintsCall(String searchTerm, Integer startIndex, Integer limit, UUID userId, List includeItemTypes, List excludeItemTypes, List mediaTypes, UUID parentId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Boolean includePeople, Boolean includeMedia, Boolean includeGenres, Boolean includeStudios, Boolean includeArtists, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -225,13 +226,13 @@ public okhttp3.Call getCall(String searchTerm, Integer startIndex, Integer limit } @SuppressWarnings("rawtypes") - private okhttp3.Call getValidateBeforeCall(String searchTerm, Integer startIndex, Integer limit, UUID userId, List includeItemTypes, List excludeItemTypes, List mediaTypes, UUID parentId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Boolean includePeople, Boolean includeMedia, Boolean includeGenres, Boolean includeStudios, Boolean includeArtists, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getSearchHintsValidateBeforeCall(String searchTerm, Integer startIndex, Integer limit, UUID userId, List includeItemTypes, List excludeItemTypes, List mediaTypes, UUID parentId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Boolean includePeople, Boolean includeMedia, Boolean includeGenres, Boolean includeStudios, Boolean includeArtists, final ApiCallback _callback) throws ApiException { // verify the required parameter 'searchTerm' is set if (searchTerm == null) { - throw new ApiException("Missing the required parameter 'searchTerm' when calling get(Async)"); + throw new ApiException("Missing the required parameter 'searchTerm' when calling getSearchHints(Async)"); } - return getCall(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists, _callback); + return getSearchHintsCall(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists, _callback); } @@ -242,9 +243,9 @@ private okhttp3.Call getValidateBeforeCall(String searchTerm, Integer startIndex * @param startIndex Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param userId Optional. Supply a user id to search within a user's library or omit to search all. (optional) - * @param includeItemTypes If specified, only results with the specified item types are returned. This allows multiple, comma delimeted. (optional) - * @param excludeItemTypes If specified, results with these item types are filtered out. This allows multiple, comma delimeted. (optional) - * @param mediaTypes If specified, only results with the specified media types are returned. This allows multiple, comma delimeted. (optional) + * @param includeItemTypes If specified, only results with the specified item types are returned. This allows multiple, comma delimited. (optional) + * @param excludeItemTypes If specified, results with these item types are filtered out. This allows multiple, comma delimited. (optional) + * @param mediaTypes If specified, only results with the specified media types are returned. This allows multiple, comma delimited. (optional) * @param parentId If specified, only children of the parent are returned. (optional) * @param isMovie Optional filter for movies. (optional) * @param isSeries Optional filter for series. (optional) @@ -267,8 +268,8 @@ private okhttp3.Call getValidateBeforeCall(String searchTerm, Integer startIndex 403 Forbidden - */ - public SearchHintResult get(String searchTerm, Integer startIndex, Integer limit, UUID userId, List includeItemTypes, List excludeItemTypes, List mediaTypes, UUID parentId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Boolean includePeople, Boolean includeMedia, Boolean includeGenres, Boolean includeStudios, Boolean includeArtists) throws ApiException { - ApiResponse localVarResp = getWithHttpInfo(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists); + public SearchHintResult getSearchHints(String searchTerm, Integer startIndex, Integer limit, UUID userId, List includeItemTypes, List excludeItemTypes, List mediaTypes, UUID parentId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Boolean includePeople, Boolean includeMedia, Boolean includeGenres, Boolean includeStudios, Boolean includeArtists) throws ApiException { + ApiResponse localVarResp = getSearchHintsWithHttpInfo(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists); return localVarResp.getData(); } @@ -279,9 +280,9 @@ public SearchHintResult get(String searchTerm, Integer startIndex, Integer limit * @param startIndex Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param userId Optional. Supply a user id to search within a user's library or omit to search all. (optional) - * @param includeItemTypes If specified, only results with the specified item types are returned. This allows multiple, comma delimeted. (optional) - * @param excludeItemTypes If specified, results with these item types are filtered out. This allows multiple, comma delimeted. (optional) - * @param mediaTypes If specified, only results with the specified media types are returned. This allows multiple, comma delimeted. (optional) + * @param includeItemTypes If specified, only results with the specified item types are returned. This allows multiple, comma delimited. (optional) + * @param excludeItemTypes If specified, results with these item types are filtered out. This allows multiple, comma delimited. (optional) + * @param mediaTypes If specified, only results with the specified media types are returned. This allows multiple, comma delimited. (optional) * @param parentId If specified, only children of the parent are returned. (optional) * @param isMovie Optional filter for movies. (optional) * @param isSeries Optional filter for series. (optional) @@ -304,8 +305,8 @@ public SearchHintResult get(String searchTerm, Integer startIndex, Integer limit 403 Forbidden - */ - public ApiResponse getWithHttpInfo(String searchTerm, Integer startIndex, Integer limit, UUID userId, List includeItemTypes, List excludeItemTypes, List mediaTypes, UUID parentId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Boolean includePeople, Boolean includeMedia, Boolean includeGenres, Boolean includeStudios, Boolean includeArtists) throws ApiException { - okhttp3.Call localVarCall = getValidateBeforeCall(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists, null); + public ApiResponse getSearchHintsWithHttpInfo(String searchTerm, Integer startIndex, Integer limit, UUID userId, List includeItemTypes, List excludeItemTypes, List mediaTypes, UUID parentId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Boolean includePeople, Boolean includeMedia, Boolean includeGenres, Boolean includeStudios, Boolean includeArtists) throws ApiException { + okhttp3.Call localVarCall = getSearchHintsValidateBeforeCall(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -317,9 +318,9 @@ public ApiResponse getWithHttpInfo(String searchTerm, Integer * @param startIndex Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional) * @param limit Optional. The maximum number of records to return. (optional) * @param userId Optional. Supply a user id to search within a user's library or omit to search all. (optional) - * @param includeItemTypes If specified, only results with the specified item types are returned. This allows multiple, comma delimeted. (optional) - * @param excludeItemTypes If specified, results with these item types are filtered out. This allows multiple, comma delimeted. (optional) - * @param mediaTypes If specified, only results with the specified media types are returned. This allows multiple, comma delimeted. (optional) + * @param includeItemTypes If specified, only results with the specified item types are returned. This allows multiple, comma delimited. (optional) + * @param excludeItemTypes If specified, results with these item types are filtered out. This allows multiple, comma delimited. (optional) + * @param mediaTypes If specified, only results with the specified media types are returned. This allows multiple, comma delimited. (optional) * @param parentId If specified, only children of the parent are returned. (optional) * @param isMovie Optional filter for movies. (optional) * @param isSeries Optional filter for series. (optional) @@ -343,9 +344,9 @@ public ApiResponse getWithHttpInfo(String searchTerm, Integer 403 Forbidden - */ - public okhttp3.Call getAsync(String searchTerm, Integer startIndex, Integer limit, UUID userId, List includeItemTypes, List excludeItemTypes, List mediaTypes, UUID parentId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Boolean includePeople, Boolean includeMedia, Boolean includeGenres, Boolean includeStudios, Boolean includeArtists, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getSearchHintsAsync(String searchTerm, Integer startIndex, Integer limit, UUID userId, List includeItemTypes, List excludeItemTypes, List mediaTypes, UUID parentId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, Boolean includePeople, Boolean includeMedia, Boolean includeGenres, Boolean includeStudios, Boolean includeArtists, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getValidateBeforeCall(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists, _callback); + okhttp3.Call localVarCall = getSearchHintsValidateBeforeCall(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SessionApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SessionApi.java similarity index 97% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SessionApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SessionApi.java index f580d3350ca0a..590ff89e4ea58 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SessionApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SessionApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -31,11 +31,12 @@ import org.openapitools.client.model.ClientCapabilitiesDto; import org.openapitools.client.model.GeneralCommand; import org.openapitools.client.model.GeneralCommandType; +import org.openapitools.client.model.MediaType; import org.openapitools.client.model.MessageCommand; import org.openapitools.client.model.NameIdPair; import org.openapitools.client.model.PlayCommand; import org.openapitools.client.model.PlaystateCommand; -import org.openapitools.client.model.SessionInfo; +import org.openapitools.client.model.SessionInfoDto; import java.util.UUID; import java.lang.reflect.Type; @@ -731,7 +732,7 @@ private okhttp3.Call getSessionsValidateBeforeCall(UUID controllableByUserId, St * @param controllableByUserId Filter by sessions that a given user is allowed to remote control. (optional) * @param deviceId Filter by device Id. (optional) * @param activeWithinSeconds Optional. Filter by sessions that were active in the last n seconds. (optional) - * @return List<SessionInfo> + * @return List<SessionInfoDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -742,8 +743,8 @@ private okhttp3.Call getSessionsValidateBeforeCall(UUID controllableByUserId, St
403 Forbidden -
*/ - public List getSessions(UUID controllableByUserId, String deviceId, Integer activeWithinSeconds) throws ApiException { - ApiResponse> localVarResp = getSessionsWithHttpInfo(controllableByUserId, deviceId, activeWithinSeconds); + public List getSessions(UUID controllableByUserId, String deviceId, Integer activeWithinSeconds) throws ApiException { + ApiResponse> localVarResp = getSessionsWithHttpInfo(controllableByUserId, deviceId, activeWithinSeconds); return localVarResp.getData(); } @@ -753,7 +754,7 @@ public List getSessions(UUID controllableByUserId, String deviceId, * @param controllableByUserId Filter by sessions that a given user is allowed to remote control. (optional) * @param deviceId Filter by device Id. (optional) * @param activeWithinSeconds Optional. Filter by sessions that were active in the last n seconds. (optional) - * @return ApiResponse<List<SessionInfo>> + * @return ApiResponse<List<SessionInfoDto>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -764,9 +765,9 @@ public List getSessions(UUID controllableByUserId, String deviceId,
403 Forbidden -
*/ - public ApiResponse> getSessionsWithHttpInfo(UUID controllableByUserId, String deviceId, Integer activeWithinSeconds) throws ApiException { + public ApiResponse> getSessionsWithHttpInfo(UUID controllableByUserId, String deviceId, Integer activeWithinSeconds) throws ApiException { okhttp3.Call localVarCall = getSessionsValidateBeforeCall(controllableByUserId, deviceId, activeWithinSeconds, null); - Type localVarReturnType = new TypeToken>(){}.getType(); + Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -788,10 +789,10 @@ public ApiResponse> getSessionsWithHttpInfo(UUID controllableB 403 Forbidden - */ - public okhttp3.Call getSessionsAsync(UUID controllableByUserId, String deviceId, Integer activeWithinSeconds, final ApiCallback> _callback) throws ApiException { + public okhttp3.Call getSessionsAsync(UUID controllableByUserId, String deviceId, Integer activeWithinSeconds, final ApiCallback> _callback) throws ApiException { okhttp3.Call localVarCall = getSessionsValidateBeforeCall(controllableByUserId, deviceId, activeWithinSeconds, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); + Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -997,7 +998,6 @@ public okhttp3.Call playAsync(String sessionId, PlayCommand playCommand, List 403 Forbidden - */ - public okhttp3.Call postCapabilitiesCall(String id, List playableMediaTypes, List supportedCommands, Boolean supportsMediaControl, Boolean supportsSync, Boolean supportsPersistentIdentifier, final ApiCallback _callback) throws ApiException { + public okhttp3.Call postCapabilitiesCall(String id, List playableMediaTypes, List supportedCommands, Boolean supportsMediaControl, Boolean supportsPersistentIdentifier, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1052,10 +1052,6 @@ public okhttp3.Call postCapabilitiesCall(String id, List playableMediaTy localVarQueryParams.addAll(localVarApiClient.parameterToPair("supportsMediaControl", supportsMediaControl)); } - if (supportsSync != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("supportsSync", supportsSync)); - } - if (supportsPersistentIdentifier != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("supportsPersistentIdentifier", supportsPersistentIdentifier)); } @@ -1079,8 +1075,8 @@ public okhttp3.Call postCapabilitiesCall(String id, List playableMediaTy } @SuppressWarnings("rawtypes") - private okhttp3.Call postCapabilitiesValidateBeforeCall(String id, List playableMediaTypes, List supportedCommands, Boolean supportsMediaControl, Boolean supportsSync, Boolean supportsPersistentIdentifier, final ApiCallback _callback) throws ApiException { - return postCapabilitiesCall(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsSync, supportsPersistentIdentifier, _callback); + private okhttp3.Call postCapabilitiesValidateBeforeCall(String id, List playableMediaTypes, List supportedCommands, Boolean supportsMediaControl, Boolean supportsPersistentIdentifier, final ApiCallback _callback) throws ApiException { + return postCapabilitiesCall(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsPersistentIdentifier, _callback); } @@ -1091,7 +1087,6 @@ private okhttp3.Call postCapabilitiesValidateBeforeCall(String id, List * @param playableMediaTypes A list of playable media types, comma delimited. Audio, Video, Book, Photo. (optional) * @param supportedCommands A list of supported remote control commands, comma delimited. (optional) * @param supportsMediaControl Determines whether media can be played remotely.. (optional, default to false) - * @param supportsSync Determines whether sync is supported. (optional, default to false) * @param supportsPersistentIdentifier Determines whether the device supports a unique identifier. (optional, default to true) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1103,8 +1098,8 @@ private okhttp3.Call postCapabilitiesValidateBeforeCall(String id, List 403 Forbidden - */ - public void postCapabilities(String id, List playableMediaTypes, List supportedCommands, Boolean supportsMediaControl, Boolean supportsSync, Boolean supportsPersistentIdentifier) throws ApiException { - postCapabilitiesWithHttpInfo(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsSync, supportsPersistentIdentifier); + public void postCapabilities(String id, List playableMediaTypes, List supportedCommands, Boolean supportsMediaControl, Boolean supportsPersistentIdentifier) throws ApiException { + postCapabilitiesWithHttpInfo(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsPersistentIdentifier); } /** @@ -1114,7 +1109,6 @@ public void postCapabilities(String id, List playableMediaTypes, List playableMediaTypes, List 403 Forbidden - */ - public ApiResponse postCapabilitiesWithHttpInfo(String id, List playableMediaTypes, List supportedCommands, Boolean supportsMediaControl, Boolean supportsSync, Boolean supportsPersistentIdentifier) throws ApiException { - okhttp3.Call localVarCall = postCapabilitiesValidateBeforeCall(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsSync, supportsPersistentIdentifier, null); + public ApiResponse postCapabilitiesWithHttpInfo(String id, List playableMediaTypes, List supportedCommands, Boolean supportsMediaControl, Boolean supportsPersistentIdentifier) throws ApiException { + okhttp3.Call localVarCall = postCapabilitiesValidateBeforeCall(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsPersistentIdentifier, null); return localVarApiClient.execute(localVarCall); } @@ -1139,7 +1133,6 @@ public ApiResponse postCapabilitiesWithHttpInfo(String id, List pl * @param playableMediaTypes A list of playable media types, comma delimited. Audio, Video, Book, Photo. (optional) * @param supportedCommands A list of supported remote control commands, comma delimited. (optional) * @param supportsMediaControl Determines whether media can be played remotely.. (optional, default to false) - * @param supportsSync Determines whether sync is supported. (optional, default to false) * @param supportsPersistentIdentifier Determines whether the device supports a unique identifier. (optional, default to true) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1153,9 +1146,9 @@ public ApiResponse postCapabilitiesWithHttpInfo(String id, List pl 403 Forbidden - */ - public okhttp3.Call postCapabilitiesAsync(String id, List playableMediaTypes, List supportedCommands, Boolean supportsMediaControl, Boolean supportsSync, Boolean supportsPersistentIdentifier, final ApiCallback _callback) throws ApiException { + public okhttp3.Call postCapabilitiesAsync(String id, List playableMediaTypes, List supportedCommands, Boolean supportsMediaControl, Boolean supportsPersistentIdentifier, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = postCapabilitiesValidateBeforeCall(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsSync, supportsPersistentIdentifier, _callback); + okhttp3.Call localVarCall = postCapabilitiesValidateBeforeCall(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsPersistentIdentifier, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/StartupApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/StartupApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/StartupApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/StartupApi.java index 5efbe64f91cee..c7142f2d77b30 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/StartupApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/StartupApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/StudiosApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/StudiosApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/StudiosApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/StudiosApi.java index ef76f8c240754..cd3e43c7879a8 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/StudiosApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/StudiosApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SubtitleApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SubtitleApi.java similarity index 96% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SubtitleApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SubtitleApi.java index cbab4999b1744..da355998d521b 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SubtitleApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SubtitleApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -236,6 +236,7 @@ public okhttp3.Call deleteSubtitleAsync(UUID itemId, Integer index, final ApiCal Response Details Status Code Description Response Headers 204 Subtitle downloaded. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -268,6 +269,9 @@ public okhttp3.Call downloadRemoteSubtitlesCall(UUID itemId, String subtitleId, Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -312,6 +316,7 @@ private okhttp3.Call downloadRemoteSubtitlesValidateBeforeCall(UUID itemId, Stri Response Details Status Code Description Response Headers 204 Subtitle downloaded. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -332,6 +337,7 @@ public void downloadRemoteSubtitles(UUID itemId, String subtitleId) throws ApiEx Response Details Status Code Description Response Headers 204 Subtitle downloaded. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -354,6 +360,7 @@ public ApiResponse downloadRemoteSubtitlesWithHttpInfo(UUID itemId, String Response Details Status Code Description Response Headers 204 Subtitle downloaded. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -628,7 +635,7 @@ public okhttp3.Call getFallbackFontListAsync(final ApiCallback> _ } /** * Build call for getRemoteSubtitles - * @param id The item id. (required) + * @param subtitleId The item id. (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -641,7 +648,7 @@ public okhttp3.Call getFallbackFontListAsync(final ApiCallback> _ 403 Forbidden - */ - public okhttp3.Call getRemoteSubtitlesCall(String id, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getRemoteSubtitlesCall(String subtitleId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -658,8 +665,8 @@ public okhttp3.Call getRemoteSubtitlesCall(String id, final ApiCallback _callbac Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Providers/Subtitles/Subtitles/{id}" - .replace("{" + "id" + "}", localVarApiClient.escapeString(id.toString())); + String localVarPath = "/Providers/Subtitles/Subtitles/{subtitleId}" + .replace("{" + "subtitleId" + "}", localVarApiClient.escapeString(subtitleId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -687,20 +694,20 @@ public okhttp3.Call getRemoteSubtitlesCall(String id, final ApiCallback _callbac } @SuppressWarnings("rawtypes") - private okhttp3.Call getRemoteSubtitlesValidateBeforeCall(String id, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException("Missing the required parameter 'id' when calling getRemoteSubtitles(Async)"); + private okhttp3.Call getRemoteSubtitlesValidateBeforeCall(String subtitleId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'subtitleId' is set + if (subtitleId == null) { + throw new ApiException("Missing the required parameter 'subtitleId' when calling getRemoteSubtitles(Async)"); } - return getRemoteSubtitlesCall(id, _callback); + return getRemoteSubtitlesCall(subtitleId, _callback); } /** * Gets the remote subtitles. * - * @param id The item id. (required) + * @param subtitleId The item id. (required) * @return File * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -712,15 +719,15 @@ private okhttp3.Call getRemoteSubtitlesValidateBeforeCall(String id, final ApiCa 403 Forbidden - */ - public File getRemoteSubtitles(String id) throws ApiException { - ApiResponse localVarResp = getRemoteSubtitlesWithHttpInfo(id); + public File getRemoteSubtitles(String subtitleId) throws ApiException { + ApiResponse localVarResp = getRemoteSubtitlesWithHttpInfo(subtitleId); return localVarResp.getData(); } /** * Gets the remote subtitles. * - * @param id The item id. (required) + * @param subtitleId The item id. (required) * @return ApiResponse<File> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -732,8 +739,8 @@ public File getRemoteSubtitles(String id) throws ApiException { 403 Forbidden - */ - public ApiResponse getRemoteSubtitlesWithHttpInfo(String id) throws ApiException { - okhttp3.Call localVarCall = getRemoteSubtitlesValidateBeforeCall(id, null); + public ApiResponse getRemoteSubtitlesWithHttpInfo(String subtitleId) throws ApiException { + okhttp3.Call localVarCall = getRemoteSubtitlesValidateBeforeCall(subtitleId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -741,7 +748,7 @@ public ApiResponse getRemoteSubtitlesWithHttpInfo(String id) throws ApiExc /** * Gets the remote subtitles. (asynchronously) * - * @param id The item id. (required) + * @param subtitleId The item id. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -754,9 +761,9 @@ public ApiResponse getRemoteSubtitlesWithHttpInfo(String id) throws ApiExc 403 Forbidden - */ - public okhttp3.Call getRemoteSubtitlesAsync(String id, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getRemoteSubtitlesAsync(String subtitleId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getRemoteSubtitlesValidateBeforeCall(id, _callback); + okhttp3.Call localVarCall = getRemoteSubtitlesValidateBeforeCall(subtitleId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -996,6 +1003,7 @@ public okhttp3.Call getSubtitleAsync(UUID routeItemId, String routeMediaSourceId Response Details Status Code Description Response Headers 200 Subtitle playlist retrieved. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1033,7 +1041,10 @@ public okhttp3.Call getSubtitlePlaylistCall(UUID itemId, Integer index, String m } final String[] localVarAccepts = { - "application/x-mpegURL" + "application/x-mpegURL", + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -1091,6 +1102,7 @@ private okhttp3.Call getSubtitlePlaylistValidateBeforeCall(UUID itemId, Integer Response Details Status Code Description Response Headers 200 Subtitle playlist retrieved. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1114,6 +1126,7 @@ public File getSubtitlePlaylist(UUID itemId, Integer index, String mediaSourceId Response Details Status Code Description Response Headers 200 Subtitle playlist retrieved. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1139,6 +1152,7 @@ public ApiResponse getSubtitlePlaylistWithHttpInfo(UUID itemId, Integer in Response Details Status Code Description Response Headers 200 Subtitle playlist retrieved. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1394,6 +1408,7 @@ public okhttp3.Call getSubtitleWithTicksAsync(UUID routeItemId, String routeMedi Response Details Status Code Description Response Headers 200 Subtitles retrieved. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1479,6 +1494,7 @@ private okhttp3.Call searchRemoteSubtitlesValidateBeforeCall(UUID itemId, String Response Details Status Code Description Response Headers 200 Subtitles retrieved. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1501,6 +1517,7 @@ public List searchRemoteSubtitles(UUID itemId, String langua Response Details Status Code Description Response Headers 200 Subtitles retrieved. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1525,6 +1542,7 @@ public ApiResponse> searchRemoteSubtitlesWithHttpInfo(U Response Details Status Code Description Response Headers 200 Subtitles retrieved. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1548,6 +1566,7 @@ public okhttp3.Call searchRemoteSubtitlesAsync(UUID itemId, String language, Boo Response Details Status Code Description Response Headers 204 Subtitle uploaded. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1579,6 +1598,9 @@ public okhttp3.Call uploadSubtitleCall(UUID itemId, UploadSubtitleDto uploadSubt Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -1626,6 +1648,7 @@ private okhttp3.Call uploadSubtitleValidateBeforeCall(UUID itemId, UploadSubtitl Response Details Status Code Description Response Headers 204 Subtitle uploaded. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1646,6 +1669,7 @@ public void uploadSubtitle(UUID itemId, UploadSubtitleDto uploadSubtitleDto) thr Response Details Status Code Description Response Headers 204 Subtitle uploaded. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - @@ -1668,6 +1692,7 @@ public ApiResponse uploadSubtitleWithHttpInfo(UUID itemId, UploadSubtitleD Response Details Status Code Description Response Headers 204 Subtitle uploaded. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SuggestionsApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SuggestionsApi.java similarity index 86% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SuggestionsApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SuggestionsApi.java index 811a60b0d7301..c7c331fd1104d 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SuggestionsApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SuggestionsApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -29,6 +29,7 @@ import org.openapitools.client.model.BaseItemDtoQueryResult; import org.openapitools.client.model.BaseItemKind; +import org.openapitools.client.model.MediaType; import java.util.UUID; import java.lang.reflect.Type; @@ -76,7 +77,7 @@ public void setCustomBaseUrl(String customBaseUrl) { /** * Build call for getSuggestions - * @param userId The user id. (required) + * @param userId The user id. (optional) * @param mediaType The media types. (optional) * @param type The type. (optional) * @param startIndex Optional. The start index. (optional) @@ -94,7 +95,7 @@ public void setCustomBaseUrl(String customBaseUrl) { 403 Forbidden - */ - public okhttp3.Call getSuggestionsCall(UUID userId, List mediaType, List type, Integer startIndex, Integer limit, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getSuggestionsCall(UUID userId, List mediaType, List type, Integer startIndex, Integer limit, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -111,8 +112,7 @@ public okhttp3.Call getSuggestionsCall(UUID userId, List mediaType, List Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/Suggestions" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())); + String localVarPath = "/Items/Suggestions"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -120,6 +120,10 @@ public okhttp3.Call getSuggestionsCall(UUID userId, List mediaType, List Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + if (mediaType != null) { localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "mediaType", mediaType)); } @@ -162,12 +166,7 @@ public okhttp3.Call getSuggestionsCall(UUID userId, List mediaType, List } @SuppressWarnings("rawtypes") - private okhttp3.Call getSuggestionsValidateBeforeCall(UUID userId, List mediaType, List type, Integer startIndex, Integer limit, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling getSuggestions(Async)"); - } - + private okhttp3.Call getSuggestionsValidateBeforeCall(UUID userId, List mediaType, List type, Integer startIndex, Integer limit, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { return getSuggestionsCall(userId, mediaType, type, startIndex, limit, enableTotalRecordCount, _callback); } @@ -175,7 +174,7 @@ private okhttp3.Call getSuggestionsValidateBeforeCall(UUID userId, List /** * Gets suggestions. * - * @param userId The user id. (required) + * @param userId The user id. (optional) * @param mediaType The media types. (optional) * @param type The type. (optional) * @param startIndex Optional. The start index. (optional) @@ -192,7 +191,7 @@ private okhttp3.Call getSuggestionsValidateBeforeCall(UUID userId, List 403 Forbidden - */ - public BaseItemDtoQueryResult getSuggestions(UUID userId, List mediaType, List type, Integer startIndex, Integer limit, Boolean enableTotalRecordCount) throws ApiException { + public BaseItemDtoQueryResult getSuggestions(UUID userId, List mediaType, List type, Integer startIndex, Integer limit, Boolean enableTotalRecordCount) throws ApiException { ApiResponse localVarResp = getSuggestionsWithHttpInfo(userId, mediaType, type, startIndex, limit, enableTotalRecordCount); return localVarResp.getData(); } @@ -200,7 +199,7 @@ public BaseItemDtoQueryResult getSuggestions(UUID userId, List mediaType /** * Gets suggestions. * - * @param userId The user id. (required) + * @param userId The user id. (optional) * @param mediaType The media types. (optional) * @param type The type. (optional) * @param startIndex Optional. The start index. (optional) @@ -217,7 +216,7 @@ public BaseItemDtoQueryResult getSuggestions(UUID userId, List mediaType 403 Forbidden - */ - public ApiResponse getSuggestionsWithHttpInfo(UUID userId, List mediaType, List type, Integer startIndex, Integer limit, Boolean enableTotalRecordCount) throws ApiException { + public ApiResponse getSuggestionsWithHttpInfo(UUID userId, List mediaType, List type, Integer startIndex, Integer limit, Boolean enableTotalRecordCount) throws ApiException { okhttp3.Call localVarCall = getSuggestionsValidateBeforeCall(userId, mediaType, type, startIndex, limit, enableTotalRecordCount, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); @@ -226,7 +225,7 @@ public ApiResponse getSuggestionsWithHttpInfo(UUID userI /** * Gets suggestions. (asynchronously) * - * @param userId The user id. (required) + * @param userId The user id. (optional) * @param mediaType The media types. (optional) * @param type The type. (optional) * @param startIndex Optional. The start index. (optional) @@ -244,7 +243,7 @@ public ApiResponse getSuggestionsWithHttpInfo(UUID userI 403 Forbidden - */ - public okhttp3.Call getSuggestionsAsync(UUID userId, List mediaType, List type, Integer startIndex, Integer limit, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getSuggestionsAsync(UUID userId, List mediaType, List type, Integer startIndex, Integer limit, Boolean enableTotalRecordCount, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getSuggestionsValidateBeforeCall(userId, mediaType, type, startIndex, limit, enableTotalRecordCount, _callback); Type localVarReturnType = new TypeToken(){}.getType(); diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SyncPlayApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SyncPlayApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SyncPlayApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SyncPlayApi.java index 910ac97c9e41d..9c0d950169db0 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SyncPlayApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SyncPlayApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SystemApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SystemApi.java similarity index 94% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SystemApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SystemApi.java index 948ae8395b863..39166ebb6c9da 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/SystemApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/SystemApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -30,6 +30,7 @@ import org.openapitools.client.model.EndPointInfo; import java.io.File; import org.openapitools.client.model.LogFile; +import org.openapitools.client.model.ProblemDetails; import org.openapitools.client.model.PublicSystemInfo; import org.openapitools.client.model.SystemInfo; import org.openapitools.client.model.WakeOnLanInfo; @@ -87,8 +88,8 @@ public void setCustomBaseUrl(String customBaseUrl) { Response Details Status Code Description Response Headers 200 Information retrieved. - + 403 User does not have permission to get endpoint information. - 401 Unauthorized - - 403 Forbidden - */ public okhttp3.Call getEndpointInfoCall(final ApiCallback _callback) throws ApiException { @@ -153,8 +154,8 @@ private okhttp3.Call getEndpointInfoValidateBeforeCall(final ApiCallback _callba Response Details Status Code Description Response Headers 200 Information retrieved. - + 403 User does not have permission to get endpoint information. - 401 Unauthorized - - 403 Forbidden - */ public EndPointInfo getEndpointInfo() throws ApiException { @@ -172,8 +173,8 @@ public EndPointInfo getEndpointInfo() throws ApiException { Response Details Status Code Description Response Headers 200 Information retrieved. - + 403 User does not have permission to get endpoint information. - 401 Unauthorized - - 403 Forbidden - */ public ApiResponse getEndpointInfoWithHttpInfo() throws ApiException { @@ -193,8 +194,8 @@ public ApiResponse getEndpointInfoWithHttpInfo() throws ApiExcepti Response Details Status Code Description Response Headers 200 Information retrieved. - + 403 User does not have permission to get endpoint information. - 401 Unauthorized - - 403 Forbidden - */ public okhttp3.Call getEndpointInfoAsync(final ApiCallback _callback) throws ApiException { @@ -215,8 +216,9 @@ public okhttp3.Call getEndpointInfoAsync(final ApiCallback _callba Response Details Status Code Description Response Headers 200 Log file retrieved. - + 403 User does not have permission to get log files. - + 404 Could not find a log file with the name. - 401 Unauthorized - - 403 Forbidden - */ public okhttp3.Call getLogFileCall(String name, final ApiCallback _callback) throws ApiException { @@ -249,7 +251,10 @@ public okhttp3.Call getLogFileCall(String name, final ApiCallback _callback) thr } final String[] localVarAccepts = { - "text/plain" + "text/plain", + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -289,8 +294,9 @@ private okhttp3.Call getLogFileValidateBeforeCall(String name, final ApiCallback Response Details Status Code Description Response Headers 200 Log file retrieved. - + 403 User does not have permission to get log files. - + 404 Could not find a log file with the name. - 401 Unauthorized - - 403 Forbidden - */ public File getLogFile(String name) throws ApiException { @@ -309,8 +315,9 @@ public File getLogFile(String name) throws ApiException { Response Details Status Code Description Response Headers 200 Log file retrieved. - + 403 User does not have permission to get log files. - + 404 Could not find a log file with the name. - 401 Unauthorized - - 403 Forbidden - */ public ApiResponse getLogFileWithHttpInfo(String name) throws ApiException { @@ -331,8 +338,9 @@ public ApiResponse getLogFileWithHttpInfo(String name) throws ApiException Response Details Status Code Description Response Headers 200 Log file retrieved. - + 403 User does not have permission to get log files. - + 404 Could not find a log file with the name. - 401 Unauthorized - - 403 Forbidden - */ public okhttp3.Call getLogFileAsync(String name, final ApiCallback _callback) throws ApiException { @@ -590,8 +598,8 @@ public okhttp3.Call getPublicSystemInfoAsync(final ApiCallback Response Details Status Code Description Response Headers 200 Information retrieved. - + 403 User does not have permission to get server logs. - 401 Unauthorized - - 403 Forbidden - */ public okhttp3.Call getServerLogsCall(final ApiCallback _callback) throws ApiException { @@ -656,8 +664,8 @@ private okhttp3.Call getServerLogsValidateBeforeCall(final ApiCallback _callback Response Details Status Code Description Response Headers 200 Information retrieved. - + 403 User does not have permission to get server logs. - 401 Unauthorized - - 403 Forbidden - */ public List getServerLogs() throws ApiException { @@ -675,8 +683,8 @@ public List getServerLogs() throws ApiException { Response Details Status Code Description Response Headers 200 Information retrieved. - + 403 User does not have permission to get server logs. - 401 Unauthorized - - 403 Forbidden - */ public ApiResponse> getServerLogsWithHttpInfo() throws ApiException { @@ -696,8 +704,8 @@ public ApiResponse> getServerLogsWithHttpInfo() throws ApiExceptio Response Details Status Code Description Response Headers 200 Information retrieved. - + 403 User does not have permission to get server logs. - 401 Unauthorized - - 403 Forbidden - */ public okhttp3.Call getServerLogsAsync(final ApiCallback> _callback) throws ApiException { @@ -717,8 +725,8 @@ public okhttp3.Call getServerLogsAsync(final ApiCallback> _callbac Response Details Status Code Description Response Headers 200 Information retrieved. - + 403 User does not have permission to retrieve information. - 401 Unauthorized - - 403 Forbidden - */ public okhttp3.Call getSystemInfoCall(final ApiCallback _callback) throws ApiException { @@ -783,8 +791,8 @@ private okhttp3.Call getSystemInfoValidateBeforeCall(final ApiCallback _callback Response Details Status Code Description Response Headers 200 Information retrieved. - + 403 User does not have permission to retrieve information. - 401 Unauthorized - - 403 Forbidden - */ public SystemInfo getSystemInfo() throws ApiException { @@ -802,8 +810,8 @@ public SystemInfo getSystemInfo() throws ApiException { Response Details Status Code Description Response Headers 200 Information retrieved. - + 403 User does not have permission to retrieve information. - 401 Unauthorized - - 403 Forbidden - */ public ApiResponse getSystemInfoWithHttpInfo() throws ApiException { @@ -823,8 +831,8 @@ public ApiResponse getSystemInfoWithHttpInfo() throws ApiException { Response Details Status Code Description Response Headers 200 Information retrieved. - + 403 User does not have permission to retrieve information. - 401 Unauthorized - - 403 Forbidden - */ public okhttp3.Call getSystemInfoAsync(final ApiCallback _callback) throws ApiException { @@ -1099,8 +1107,8 @@ public okhttp3.Call postPingSystemAsync(final ApiCallback _callback) thr Response Details Status Code Description Response Headers 204 Server restarted. - + 403 User does not have permission to restart server. - 401 Unauthorized - - 403 Forbidden - */ public okhttp3.Call restartApplicationCall(final ApiCallback _callback) throws ApiException { @@ -1129,6 +1137,9 @@ public okhttp3.Call restartApplicationCall(final ApiCallback _callback) throws A Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -1161,8 +1172,8 @@ private okhttp3.Call restartApplicationValidateBeforeCall(final ApiCallback _cal Response Details Status Code Description Response Headers 204 Server restarted. - + 403 User does not have permission to restart server. - 401 Unauthorized - - 403 Forbidden - */ public void restartApplication() throws ApiException { @@ -1179,8 +1190,8 @@ public void restartApplication() throws ApiException { Response Details Status Code Description Response Headers 204 Server restarted. - + 403 User does not have permission to restart server. - 401 Unauthorized - - 403 Forbidden - */ public ApiResponse restartApplicationWithHttpInfo() throws ApiException { @@ -1199,8 +1210,8 @@ public ApiResponse restartApplicationWithHttpInfo() throws ApiException { Response Details Status Code Description Response Headers 204 Server restarted. - + 403 User does not have permission to restart server. - 401 Unauthorized - - 403 Forbidden - */ public okhttp3.Call restartApplicationAsync(final ApiCallback _callback) throws ApiException { @@ -1219,8 +1230,8 @@ public okhttp3.Call restartApplicationAsync(final ApiCallback _callback) t Response Details Status Code Description Response Headers 204 Server shut down. - + 403 User does not have permission to shutdown server. - 401 Unauthorized - - 403 Forbidden - */ public okhttp3.Call shutdownApplicationCall(final ApiCallback _callback) throws ApiException { @@ -1249,6 +1260,9 @@ public okhttp3.Call shutdownApplicationCall(final ApiCallback _callback) throws Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -1281,8 +1295,8 @@ private okhttp3.Call shutdownApplicationValidateBeforeCall(final ApiCallback _ca Response Details Status Code Description Response Headers 204 Server shut down. - + 403 User does not have permission to shutdown server. - 401 Unauthorized - - 403 Forbidden - */ public void shutdownApplication() throws ApiException { @@ -1299,8 +1313,8 @@ public void shutdownApplication() throws ApiException { Response Details Status Code Description Response Headers 204 Server shut down. - + 403 User does not have permission to shutdown server. - 401 Unauthorized - - 403 Forbidden - */ public ApiResponse shutdownApplicationWithHttpInfo() throws ApiException { @@ -1319,8 +1333,8 @@ public ApiResponse shutdownApplicationWithHttpInfo() throws ApiException { Response Details Status Code Description Response Headers 204 Server shut down. - + 403 User does not have permission to shutdown server. - 401 Unauthorized - - 403 Forbidden - */ public okhttp3.Call shutdownApplicationAsync(final ApiCallback _callback) throws ApiException { diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/TimeSyncApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/TimeSyncApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/TimeSyncApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/TimeSyncApi.java index 01eda09a08208..765da161bd46a 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/TimeSyncApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/TimeSyncApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/TmdbApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/TmdbApi.java similarity index 99% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/TmdbApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/TmdbApi.java index b27971d61a6fc..5fd576e2b3c34 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/TmdbApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/TmdbApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/TrailersApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/TrailersApi.java similarity index 86% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/TrailersApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/TrailersApi.java index 05999bebb7549..5a51b01d9ed06 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/TrailersApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/TrailersApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -32,7 +32,9 @@ import org.openapitools.client.model.ImageType; import org.openapitools.client.model.ItemFields; import org.openapitools.client.model.ItemFilter; +import org.openapitools.client.model.ItemSortBy; import org.openapitools.client.model.LocationType; +import org.openapitools.client.model.MediaType; import java.time.OffsetDateTime; import org.openapitools.client.model.SeriesStatus; import org.openapitools.client.model.SortOrder; @@ -84,7 +86,7 @@ public void setCustomBaseUrl(String customBaseUrl) { /** * Build call for getTrailers - * @param userId The user id. (optional) + * @param userId The user id supplied as query parameter; this is required when not using an API key. (optional) * @param maxOfficialRating Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). (optional) * @param hasThemeSong Optional filter by items with theme songs. (optional) * @param hasThemeVideo Optional filter by items with theme videos. (optional) @@ -107,9 +109,9 @@ public void setCustomBaseUrl(String customBaseUrl) { * @param minDateLastSavedForUser Optional. The minimum last saved date for the current user. Format = ISO. (optional) * @param maxPremiereDate Optional. The maximum premiere date. Format = ISO. (optional) * @param hasOverview Optional filter by items that have an overview or not. (optional) - * @param hasImdbId Optional filter by items that have an imdb id or not. (optional) - * @param hasTmdbId Optional filter by items that have a tmdb id or not. (optional) - * @param hasTvdbId Optional filter by items that have a tvdb id or not. (optional) + * @param hasImdbId Optional filter by items that have an IMDb id or not. (optional) + * @param hasTmdbId Optional filter by items that have a TMDb id or not. (optional) + * @param hasTvdbId Optional filter by items that have a TVDb id or not. (optional) * @param isMovie Optional filter for live tv movies. (optional) * @param isSeries Optional filter for live tv series. (optional) * @param isNews Optional filter for live tv news. (optional) @@ -120,7 +122,7 @@ public void setCustomBaseUrl(String customBaseUrl) { * @param limit Optional. The maximum number of records to return. (optional) * @param recursive When searching within folders, this determines whether or not the search will be recursive. true/false. (optional) * @param searchTerm Optional. Filter based on a search term. (optional) - * @param sortOrder Sort Order - Ascending,Descending. (optional) + * @param sortOrder Sort Order - Ascending, Descending. (optional) * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. (optional) * @param fields 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. (optional) * @param excludeItemTypes Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional) @@ -180,7 +182,7 @@ public void setCustomBaseUrl(String customBaseUrl) { 403 Forbidden - */ - public okhttp3.Call getTrailersCall(UUID userId, String maxOfficialRating, Boolean hasThemeSong, Boolean hasThemeVideo, Boolean hasSubtitles, Boolean hasSpecialFeature, Boolean hasTrailer, String adjacentTo, Integer parentIndexNumber, Boolean hasParentalRating, Boolean isHd, Boolean is4K, List locationTypes, List excludeLocationTypes, Boolean isMissing, Boolean isUnaired, Double minCommunityRating, Double minCriticRating, OffsetDateTime minPremiereDate, OffsetDateTime minDateLastSaved, OffsetDateTime minDateLastSavedForUser, OffsetDateTime maxPremiereDate, Boolean hasOverview, Boolean hasImdbId, Boolean hasTmdbId, Boolean hasTvdbId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, List excludeItemIds, Integer startIndex, Integer limit, Boolean recursive, String searchTerm, List sortOrder, UUID parentId, List fields, List excludeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List imageTypes, List sortBy, Boolean isPlayed, List genres, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List artists, List excludeArtistIds, List artistIds, List albumArtistIds, List contributingArtistIds, List albums, List albumIds, List ids, List videoTypes, String minOfficialRating, Boolean isLocked, Boolean isPlaceHolder, Boolean hasOfficialRating, Boolean collapseBoxSetItems, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight, Boolean is3D, List seriesStatus, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List studioIds, List genreIds, Boolean enableTotalRecordCount, Boolean enableImages, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getTrailersCall(UUID userId, String maxOfficialRating, Boolean hasThemeSong, Boolean hasThemeVideo, Boolean hasSubtitles, Boolean hasSpecialFeature, Boolean hasTrailer, UUID adjacentTo, Integer parentIndexNumber, Boolean hasParentalRating, Boolean isHd, Boolean is4K, List locationTypes, List excludeLocationTypes, Boolean isMissing, Boolean isUnaired, Double minCommunityRating, Double minCriticRating, OffsetDateTime minPremiereDate, OffsetDateTime minDateLastSaved, OffsetDateTime minDateLastSavedForUser, OffsetDateTime maxPremiereDate, Boolean hasOverview, Boolean hasImdbId, Boolean hasTmdbId, Boolean hasTvdbId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, List excludeItemIds, Integer startIndex, Integer limit, Boolean recursive, String searchTerm, List sortOrder, UUID parentId, List fields, List excludeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List imageTypes, List sortBy, Boolean isPlayed, List genres, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List artists, List excludeArtistIds, List artistIds, List albumArtistIds, List contributingArtistIds, List albums, List albumIds, List ids, List videoTypes, String minOfficialRating, Boolean isLocked, Boolean isPlaceHolder, Boolean hasOfficialRating, Boolean collapseBoxSetItems, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight, Boolean is3D, List seriesStatus, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List studioIds, List genreIds, Boolean enableTotalRecordCount, Boolean enableImages, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -563,7 +565,7 @@ public okhttp3.Call getTrailersCall(UUID userId, String maxOfficialRating, Boole } @SuppressWarnings("rawtypes") - private okhttp3.Call getTrailersValidateBeforeCall(UUID userId, String maxOfficialRating, Boolean hasThemeSong, Boolean hasThemeVideo, Boolean hasSubtitles, Boolean hasSpecialFeature, Boolean hasTrailer, String adjacentTo, Integer parentIndexNumber, Boolean hasParentalRating, Boolean isHd, Boolean is4K, List locationTypes, List excludeLocationTypes, Boolean isMissing, Boolean isUnaired, Double minCommunityRating, Double minCriticRating, OffsetDateTime minPremiereDate, OffsetDateTime minDateLastSaved, OffsetDateTime minDateLastSavedForUser, OffsetDateTime maxPremiereDate, Boolean hasOverview, Boolean hasImdbId, Boolean hasTmdbId, Boolean hasTvdbId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, List excludeItemIds, Integer startIndex, Integer limit, Boolean recursive, String searchTerm, List sortOrder, UUID parentId, List fields, List excludeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List imageTypes, List sortBy, Boolean isPlayed, List genres, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List artists, List excludeArtistIds, List artistIds, List albumArtistIds, List contributingArtistIds, List albums, List albumIds, List ids, List videoTypes, String minOfficialRating, Boolean isLocked, Boolean isPlaceHolder, Boolean hasOfficialRating, Boolean collapseBoxSetItems, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight, Boolean is3D, List seriesStatus, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List studioIds, List genreIds, Boolean enableTotalRecordCount, Boolean enableImages, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getTrailersValidateBeforeCall(UUID userId, String maxOfficialRating, Boolean hasThemeSong, Boolean hasThemeVideo, Boolean hasSubtitles, Boolean hasSpecialFeature, Boolean hasTrailer, UUID adjacentTo, Integer parentIndexNumber, Boolean hasParentalRating, Boolean isHd, Boolean is4K, List locationTypes, List excludeLocationTypes, Boolean isMissing, Boolean isUnaired, Double minCommunityRating, Double minCriticRating, OffsetDateTime minPremiereDate, OffsetDateTime minDateLastSaved, OffsetDateTime minDateLastSavedForUser, OffsetDateTime maxPremiereDate, Boolean hasOverview, Boolean hasImdbId, Boolean hasTmdbId, Boolean hasTvdbId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, List excludeItemIds, Integer startIndex, Integer limit, Boolean recursive, String searchTerm, List sortOrder, UUID parentId, List fields, List excludeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List imageTypes, List sortBy, Boolean isPlayed, List genres, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List artists, List excludeArtistIds, List artistIds, List albumArtistIds, List contributingArtistIds, List albums, List albumIds, List ids, List videoTypes, String minOfficialRating, Boolean isLocked, Boolean isPlaceHolder, Boolean hasOfficialRating, Boolean collapseBoxSetItems, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight, Boolean is3D, List seriesStatus, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List studioIds, List genreIds, Boolean enableTotalRecordCount, Boolean enableImages, final ApiCallback _callback) throws ApiException { return getTrailersCall(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, _callback); } @@ -571,7 +573,7 @@ private okhttp3.Call getTrailersValidateBeforeCall(UUID userId, String maxOffici /** * Finds movies and trailers similar to a given trailer. * - * @param userId The user id. (optional) + * @param userId The user id supplied as query parameter; this is required when not using an API key. (optional) * @param maxOfficialRating Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). (optional) * @param hasThemeSong Optional filter by items with theme songs. (optional) * @param hasThemeVideo Optional filter by items with theme videos. (optional) @@ -594,9 +596,9 @@ private okhttp3.Call getTrailersValidateBeforeCall(UUID userId, String maxOffici * @param minDateLastSavedForUser Optional. The minimum last saved date for the current user. Format = ISO. (optional) * @param maxPremiereDate Optional. The maximum premiere date. Format = ISO. (optional) * @param hasOverview Optional filter by items that have an overview or not. (optional) - * @param hasImdbId Optional filter by items that have an imdb id or not. (optional) - * @param hasTmdbId Optional filter by items that have a tmdb id or not. (optional) - * @param hasTvdbId Optional filter by items that have a tvdb id or not. (optional) + * @param hasImdbId Optional filter by items that have an IMDb id or not. (optional) + * @param hasTmdbId Optional filter by items that have a TMDb id or not. (optional) + * @param hasTvdbId Optional filter by items that have a TVDb id or not. (optional) * @param isMovie Optional filter for live tv movies. (optional) * @param isSeries Optional filter for live tv series. (optional) * @param isNews Optional filter for live tv news. (optional) @@ -607,7 +609,7 @@ private okhttp3.Call getTrailersValidateBeforeCall(UUID userId, String maxOffici * @param limit Optional. The maximum number of records to return. (optional) * @param recursive When searching within folders, this determines whether or not the search will be recursive. true/false. (optional) * @param searchTerm Optional. Filter based on a search term. (optional) - * @param sortOrder Sort Order - Ascending,Descending. (optional) + * @param sortOrder Sort Order - Ascending, Descending. (optional) * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. (optional) * @param fields 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. (optional) * @param excludeItemTypes Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional) @@ -666,7 +668,7 @@ private okhttp3.Call getTrailersValidateBeforeCall(UUID userId, String maxOffici 403 Forbidden - */ - public BaseItemDtoQueryResult getTrailers(UUID userId, String maxOfficialRating, Boolean hasThemeSong, Boolean hasThemeVideo, Boolean hasSubtitles, Boolean hasSpecialFeature, Boolean hasTrailer, String adjacentTo, Integer parentIndexNumber, Boolean hasParentalRating, Boolean isHd, Boolean is4K, List locationTypes, List excludeLocationTypes, Boolean isMissing, Boolean isUnaired, Double minCommunityRating, Double minCriticRating, OffsetDateTime minPremiereDate, OffsetDateTime minDateLastSaved, OffsetDateTime minDateLastSavedForUser, OffsetDateTime maxPremiereDate, Boolean hasOverview, Boolean hasImdbId, Boolean hasTmdbId, Boolean hasTvdbId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, List excludeItemIds, Integer startIndex, Integer limit, Boolean recursive, String searchTerm, List sortOrder, UUID parentId, List fields, List excludeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List imageTypes, List sortBy, Boolean isPlayed, List genres, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List artists, List excludeArtistIds, List artistIds, List albumArtistIds, List contributingArtistIds, List albums, List albumIds, List ids, List videoTypes, String minOfficialRating, Boolean isLocked, Boolean isPlaceHolder, Boolean hasOfficialRating, Boolean collapseBoxSetItems, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight, Boolean is3D, List seriesStatus, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List studioIds, List genreIds, Boolean enableTotalRecordCount, Boolean enableImages) throws ApiException { + public BaseItemDtoQueryResult getTrailers(UUID userId, String maxOfficialRating, Boolean hasThemeSong, Boolean hasThemeVideo, Boolean hasSubtitles, Boolean hasSpecialFeature, Boolean hasTrailer, UUID adjacentTo, Integer parentIndexNumber, Boolean hasParentalRating, Boolean isHd, Boolean is4K, List locationTypes, List excludeLocationTypes, Boolean isMissing, Boolean isUnaired, Double minCommunityRating, Double minCriticRating, OffsetDateTime minPremiereDate, OffsetDateTime minDateLastSaved, OffsetDateTime minDateLastSavedForUser, OffsetDateTime maxPremiereDate, Boolean hasOverview, Boolean hasImdbId, Boolean hasTmdbId, Boolean hasTvdbId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, List excludeItemIds, Integer startIndex, Integer limit, Boolean recursive, String searchTerm, List sortOrder, UUID parentId, List fields, List excludeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List imageTypes, List sortBy, Boolean isPlayed, List genres, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List artists, List excludeArtistIds, List artistIds, List albumArtistIds, List contributingArtistIds, List albums, List albumIds, List ids, List videoTypes, String minOfficialRating, Boolean isLocked, Boolean isPlaceHolder, Boolean hasOfficialRating, Boolean collapseBoxSetItems, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight, Boolean is3D, List seriesStatus, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List studioIds, List genreIds, Boolean enableTotalRecordCount, Boolean enableImages) throws ApiException { ApiResponse localVarResp = getTrailersWithHttpInfo(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages); return localVarResp.getData(); } @@ -674,7 +676,7 @@ public BaseItemDtoQueryResult getTrailers(UUID userId, String maxOfficialRating, /** * Finds movies and trailers similar to a given trailer. * - * @param userId The user id. (optional) + * @param userId The user id supplied as query parameter; this is required when not using an API key. (optional) * @param maxOfficialRating Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). (optional) * @param hasThemeSong Optional filter by items with theme songs. (optional) * @param hasThemeVideo Optional filter by items with theme videos. (optional) @@ -697,9 +699,9 @@ public BaseItemDtoQueryResult getTrailers(UUID userId, String maxOfficialRating, * @param minDateLastSavedForUser Optional. The minimum last saved date for the current user. Format = ISO. (optional) * @param maxPremiereDate Optional. The maximum premiere date. Format = ISO. (optional) * @param hasOverview Optional filter by items that have an overview or not. (optional) - * @param hasImdbId Optional filter by items that have an imdb id or not. (optional) - * @param hasTmdbId Optional filter by items that have a tmdb id or not. (optional) - * @param hasTvdbId Optional filter by items that have a tvdb id or not. (optional) + * @param hasImdbId Optional filter by items that have an IMDb id or not. (optional) + * @param hasTmdbId Optional filter by items that have a TMDb id or not. (optional) + * @param hasTvdbId Optional filter by items that have a TVDb id or not. (optional) * @param isMovie Optional filter for live tv movies. (optional) * @param isSeries Optional filter for live tv series. (optional) * @param isNews Optional filter for live tv news. (optional) @@ -710,7 +712,7 @@ public BaseItemDtoQueryResult getTrailers(UUID userId, String maxOfficialRating, * @param limit Optional. The maximum number of records to return. (optional) * @param recursive When searching within folders, this determines whether or not the search will be recursive. true/false. (optional) * @param searchTerm Optional. Filter based on a search term. (optional) - * @param sortOrder Sort Order - Ascending,Descending. (optional) + * @param sortOrder Sort Order - Ascending, Descending. (optional) * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. (optional) * @param fields 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. (optional) * @param excludeItemTypes Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional) @@ -769,7 +771,7 @@ public BaseItemDtoQueryResult getTrailers(UUID userId, String maxOfficialRating, 403 Forbidden - */ - public ApiResponse getTrailersWithHttpInfo(UUID userId, String maxOfficialRating, Boolean hasThemeSong, Boolean hasThemeVideo, Boolean hasSubtitles, Boolean hasSpecialFeature, Boolean hasTrailer, String adjacentTo, Integer parentIndexNumber, Boolean hasParentalRating, Boolean isHd, Boolean is4K, List locationTypes, List excludeLocationTypes, Boolean isMissing, Boolean isUnaired, Double minCommunityRating, Double minCriticRating, OffsetDateTime minPremiereDate, OffsetDateTime minDateLastSaved, OffsetDateTime minDateLastSavedForUser, OffsetDateTime maxPremiereDate, Boolean hasOverview, Boolean hasImdbId, Boolean hasTmdbId, Boolean hasTvdbId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, List excludeItemIds, Integer startIndex, Integer limit, Boolean recursive, String searchTerm, List sortOrder, UUID parentId, List fields, List excludeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List imageTypes, List sortBy, Boolean isPlayed, List genres, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List artists, List excludeArtistIds, List artistIds, List albumArtistIds, List contributingArtistIds, List albums, List albumIds, List ids, List videoTypes, String minOfficialRating, Boolean isLocked, Boolean isPlaceHolder, Boolean hasOfficialRating, Boolean collapseBoxSetItems, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight, Boolean is3D, List seriesStatus, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List studioIds, List genreIds, Boolean enableTotalRecordCount, Boolean enableImages) throws ApiException { + public ApiResponse getTrailersWithHttpInfo(UUID userId, String maxOfficialRating, Boolean hasThemeSong, Boolean hasThemeVideo, Boolean hasSubtitles, Boolean hasSpecialFeature, Boolean hasTrailer, UUID adjacentTo, Integer parentIndexNumber, Boolean hasParentalRating, Boolean isHd, Boolean is4K, List locationTypes, List excludeLocationTypes, Boolean isMissing, Boolean isUnaired, Double minCommunityRating, Double minCriticRating, OffsetDateTime minPremiereDate, OffsetDateTime minDateLastSaved, OffsetDateTime minDateLastSavedForUser, OffsetDateTime maxPremiereDate, Boolean hasOverview, Boolean hasImdbId, Boolean hasTmdbId, Boolean hasTvdbId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, List excludeItemIds, Integer startIndex, Integer limit, Boolean recursive, String searchTerm, List sortOrder, UUID parentId, List fields, List excludeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List imageTypes, List sortBy, Boolean isPlayed, List genres, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List artists, List excludeArtistIds, List artistIds, List albumArtistIds, List contributingArtistIds, List albums, List albumIds, List ids, List videoTypes, String minOfficialRating, Boolean isLocked, Boolean isPlaceHolder, Boolean hasOfficialRating, Boolean collapseBoxSetItems, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight, Boolean is3D, List seriesStatus, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List studioIds, List genreIds, Boolean enableTotalRecordCount, Boolean enableImages) throws ApiException { okhttp3.Call localVarCall = getTrailersValidateBeforeCall(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); @@ -778,7 +780,7 @@ public ApiResponse getTrailersWithHttpInfo(UUID userId, /** * Finds movies and trailers similar to a given trailer. (asynchronously) * - * @param userId The user id. (optional) + * @param userId The user id supplied as query parameter; this is required when not using an API key. (optional) * @param maxOfficialRating Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). (optional) * @param hasThemeSong Optional filter by items with theme songs. (optional) * @param hasThemeVideo Optional filter by items with theme videos. (optional) @@ -801,9 +803,9 @@ public ApiResponse getTrailersWithHttpInfo(UUID userId, * @param minDateLastSavedForUser Optional. The minimum last saved date for the current user. Format = ISO. (optional) * @param maxPremiereDate Optional. The maximum premiere date. Format = ISO. (optional) * @param hasOverview Optional filter by items that have an overview or not. (optional) - * @param hasImdbId Optional filter by items that have an imdb id or not. (optional) - * @param hasTmdbId Optional filter by items that have a tmdb id or not. (optional) - * @param hasTvdbId Optional filter by items that have a tvdb id or not. (optional) + * @param hasImdbId Optional filter by items that have an IMDb id or not. (optional) + * @param hasTmdbId Optional filter by items that have a TMDb id or not. (optional) + * @param hasTvdbId Optional filter by items that have a TVDb id or not. (optional) * @param isMovie Optional filter for live tv movies. (optional) * @param isSeries Optional filter for live tv series. (optional) * @param isNews Optional filter for live tv news. (optional) @@ -814,7 +816,7 @@ public ApiResponse getTrailersWithHttpInfo(UUID userId, * @param limit Optional. The maximum number of records to return. (optional) * @param recursive When searching within folders, this determines whether or not the search will be recursive. true/false. (optional) * @param searchTerm Optional. Filter based on a search term. (optional) - * @param sortOrder Sort Order - Ascending,Descending. (optional) + * @param sortOrder Sort Order - Ascending, Descending. (optional) * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. (optional) * @param fields 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. (optional) * @param excludeItemTypes Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional) @@ -874,7 +876,7 @@ public ApiResponse getTrailersWithHttpInfo(UUID userId, 403 Forbidden - */ - public okhttp3.Call getTrailersAsync(UUID userId, String maxOfficialRating, Boolean hasThemeSong, Boolean hasThemeVideo, Boolean hasSubtitles, Boolean hasSpecialFeature, Boolean hasTrailer, String adjacentTo, Integer parentIndexNumber, Boolean hasParentalRating, Boolean isHd, Boolean is4K, List locationTypes, List excludeLocationTypes, Boolean isMissing, Boolean isUnaired, Double minCommunityRating, Double minCriticRating, OffsetDateTime minPremiereDate, OffsetDateTime minDateLastSaved, OffsetDateTime minDateLastSavedForUser, OffsetDateTime maxPremiereDate, Boolean hasOverview, Boolean hasImdbId, Boolean hasTmdbId, Boolean hasTvdbId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, List excludeItemIds, Integer startIndex, Integer limit, Boolean recursive, String searchTerm, List sortOrder, UUID parentId, List fields, List excludeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List imageTypes, List sortBy, Boolean isPlayed, List genres, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List artists, List excludeArtistIds, List artistIds, List albumArtistIds, List contributingArtistIds, List albums, List albumIds, List ids, List videoTypes, String minOfficialRating, Boolean isLocked, Boolean isPlaceHolder, Boolean hasOfficialRating, Boolean collapseBoxSetItems, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight, Boolean is3D, List seriesStatus, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List studioIds, List genreIds, Boolean enableTotalRecordCount, Boolean enableImages, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getTrailersAsync(UUID userId, String maxOfficialRating, Boolean hasThemeSong, Boolean hasThemeVideo, Boolean hasSubtitles, Boolean hasSpecialFeature, Boolean hasTrailer, UUID adjacentTo, Integer parentIndexNumber, Boolean hasParentalRating, Boolean isHd, Boolean is4K, List locationTypes, List excludeLocationTypes, Boolean isMissing, Boolean isUnaired, Double minCommunityRating, Double minCriticRating, OffsetDateTime minPremiereDate, OffsetDateTime minDateLastSaved, OffsetDateTime minDateLastSavedForUser, OffsetDateTime maxPremiereDate, Boolean hasOverview, Boolean hasImdbId, Boolean hasTmdbId, Boolean hasTvdbId, Boolean isMovie, Boolean isSeries, Boolean isNews, Boolean isKids, Boolean isSports, List excludeItemIds, Integer startIndex, Integer limit, Boolean recursive, String searchTerm, List sortOrder, UUID parentId, List fields, List excludeItemTypes, List filters, Boolean isFavorite, List mediaTypes, List imageTypes, List sortBy, Boolean isPlayed, List genres, List officialRatings, List tags, List years, Boolean enableUserData, Integer imageTypeLimit, List enableImageTypes, String person, List personIds, List personTypes, List studios, List artists, List excludeArtistIds, List artistIds, List albumArtistIds, List contributingArtistIds, List albums, List albumIds, List ids, List videoTypes, String minOfficialRating, Boolean isLocked, Boolean isPlaceHolder, Boolean hasOfficialRating, Boolean collapseBoxSetItems, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight, Boolean is3D, List seriesStatus, String nameStartsWithOrGreater, String nameStartsWith, String nameLessThan, List studioIds, List genreIds, Boolean enableTotalRecordCount, Boolean enableImages, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getTrailersValidateBeforeCall(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, _callback); Type localVarReturnType = new TypeToken(){}.getType(); diff --git a/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/TrickplayApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/TrickplayApi.java new file mode 100644 index 0000000000000..5f02cf3e31026 --- /dev/null +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/TrickplayApi.java @@ -0,0 +1,407 @@ +/* + * Jellyfin API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 10.10.3 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package org.openapitools.client.api; + +import org.openapitools.client.ApiCallback; +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.ApiResponse; +import org.openapitools.client.Configuration; +import org.openapitools.client.Pair; +import org.openapitools.client.ProgressRequestBody; +import org.openapitools.client.ProgressResponseBody; + +import com.google.gson.reflect.TypeToken; + +import java.io.IOException; + + +import java.io.File; +import org.openapitools.client.model.ProblemDetails; +import java.util.UUID; + +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class TrickplayApi { + private ApiClient localVarApiClient; + private int localHostIndex; + private String localCustomBaseUrl; + + public TrickplayApi() { + this(Configuration.getDefaultApiClient()); + } + + public TrickplayApi(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + public ApiClient getApiClient() { + return localVarApiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + public int getHostIndex() { + return localHostIndex; + } + + public void setHostIndex(int hostIndex) { + this.localHostIndex = hostIndex; + } + + public String getCustomBaseUrl() { + return localCustomBaseUrl; + } + + public void setCustomBaseUrl(String customBaseUrl) { + this.localCustomBaseUrl = customBaseUrl; + } + + /** + * Build call for getTrickplayHlsPlaylist + * @param itemId The item id. (required) + * @param width The width of a single tile. (required) + * @param mediaSourceId The media version id, if using an alternate version. (optional) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Tiles playlist returned. -
404 Not Found -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getTrickplayHlsPlaylistCall(UUID itemId, Integer width, UUID mediaSourceId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Videos/{itemId}/Trickplay/{width}/tiles.m3u8" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())) + .replace("{" + "width" + "}", localVarApiClient.escapeString(width.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (mediaSourceId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("mediaSourceId", mediaSourceId)); + } + + final String[] localVarAccepts = { + "application/x-mpegURL", + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getTrickplayHlsPlaylistValidateBeforeCall(UUID itemId, Integer width, UUID mediaSourceId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling getTrickplayHlsPlaylist(Async)"); + } + + // verify the required parameter 'width' is set + if (width == null) { + throw new ApiException("Missing the required parameter 'width' when calling getTrickplayHlsPlaylist(Async)"); + } + + return getTrickplayHlsPlaylistCall(itemId, width, mediaSourceId, _callback); + + } + + /** + * Gets an image tiles playlist for trickplay. + * + * @param itemId The item id. (required) + * @param width The width of a single tile. (required) + * @param mediaSourceId The media version id, if using an alternate version. (optional) + * @return File + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Tiles playlist returned. -
404 Not Found -
401 Unauthorized -
403 Forbidden -
+ */ + public File getTrickplayHlsPlaylist(UUID itemId, Integer width, UUID mediaSourceId) throws ApiException { + ApiResponse localVarResp = getTrickplayHlsPlaylistWithHttpInfo(itemId, width, mediaSourceId); + return localVarResp.getData(); + } + + /** + * Gets an image tiles playlist for trickplay. + * + * @param itemId The item id. (required) + * @param width The width of a single tile. (required) + * @param mediaSourceId The media version id, if using an alternate version. (optional) + * @return ApiResponse<File> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Tiles playlist returned. -
404 Not Found -
401 Unauthorized -
403 Forbidden -
+ */ + public ApiResponse getTrickplayHlsPlaylistWithHttpInfo(UUID itemId, Integer width, UUID mediaSourceId) throws ApiException { + okhttp3.Call localVarCall = getTrickplayHlsPlaylistValidateBeforeCall(itemId, width, mediaSourceId, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Gets an image tiles playlist for trickplay. (asynchronously) + * + * @param itemId The item id. (required) + * @param width The width of a single tile. (required) + * @param mediaSourceId The media version id, if using an alternate version. (optional) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Tiles playlist returned. -
404 Not Found -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getTrickplayHlsPlaylistAsync(UUID itemId, Integer width, UUID mediaSourceId, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getTrickplayHlsPlaylistValidateBeforeCall(itemId, width, mediaSourceId, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for getTrickplayTileImage + * @param itemId The item id. (required) + * @param width The width of a single tile. (required) + * @param index The index of the desired tile. (required) + * @param mediaSourceId The media version id, if using an alternate version. (optional) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Tile image not found at specified index. -
404 Not Found -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getTrickplayTileImageCall(UUID itemId, Integer width, Integer index, UUID mediaSourceId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/Videos/{itemId}/Trickplay/{width}/{index}.jpg" + .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())) + .replace("{" + "width" + "}", localVarApiClient.escapeString(width.toString())) + .replace("{" + "index" + "}", localVarApiClient.escapeString(index.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (mediaSourceId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("mediaSourceId", mediaSourceId)); + } + + final String[] localVarAccepts = { + "image/*", + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "CustomAuthentication" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getTrickplayTileImageValidateBeforeCall(UUID itemId, Integer width, Integer index, UUID mediaSourceId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'itemId' is set + if (itemId == null) { + throw new ApiException("Missing the required parameter 'itemId' when calling getTrickplayTileImage(Async)"); + } + + // verify the required parameter 'width' is set + if (width == null) { + throw new ApiException("Missing the required parameter 'width' when calling getTrickplayTileImage(Async)"); + } + + // verify the required parameter 'index' is set + if (index == null) { + throw new ApiException("Missing the required parameter 'index' when calling getTrickplayTileImage(Async)"); + } + + return getTrickplayTileImageCall(itemId, width, index, mediaSourceId, _callback); + + } + + /** + * Gets a trickplay tile image. + * + * @param itemId The item id. (required) + * @param width The width of a single tile. (required) + * @param index The index of the desired tile. (required) + * @param mediaSourceId The media version id, if using an alternate version. (optional) + * @return File + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Tile image not found at specified index. -
404 Not Found -
401 Unauthorized -
403 Forbidden -
+ */ + public File getTrickplayTileImage(UUID itemId, Integer width, Integer index, UUID mediaSourceId) throws ApiException { + ApiResponse localVarResp = getTrickplayTileImageWithHttpInfo(itemId, width, index, mediaSourceId); + return localVarResp.getData(); + } + + /** + * Gets a trickplay tile image. + * + * @param itemId The item id. (required) + * @param width The width of a single tile. (required) + * @param index The index of the desired tile. (required) + * @param mediaSourceId The media version id, if using an alternate version. (optional) + * @return ApiResponse<File> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Tile image not found at specified index. -
404 Not Found -
401 Unauthorized -
403 Forbidden -
+ */ + public ApiResponse getTrickplayTileImageWithHttpInfo(UUID itemId, Integer width, Integer index, UUID mediaSourceId) throws ApiException { + okhttp3.Call localVarCall = getTrickplayTileImageValidateBeforeCall(itemId, width, index, mediaSourceId, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Gets a trickplay tile image. (asynchronously) + * + * @param itemId The item id. (required) + * @param width The width of a single tile. (required) + * @param index The index of the desired tile. (required) + * @param mediaSourceId The media version id, if using an alternate version. (optional) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Response Details
Status Code Description Response Headers
200 Tile image not found at specified index. -
404 Not Found -
401 Unauthorized -
403 Forbidden -
+ */ + public okhttp3.Call getTrickplayTileImageAsync(UUID itemId, Integer width, Integer index, UUID mediaSourceId, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getTrickplayTileImageValidateBeforeCall(itemId, width, index, mediaSourceId, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } +} diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/TvShowsApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/TvShowsApi.java similarity index 91% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/TvShowsApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/TvShowsApi.java index 12c1585e1813b..a52751a40439f 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/TvShowsApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/TvShowsApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -30,6 +30,7 @@ import org.openapitools.client.model.BaseItemDtoQueryResult; import org.openapitools.client.model.ImageType; import org.openapitools.client.model.ItemFields; +import org.openapitools.client.model.ItemSortBy; import java.time.OffsetDateTime; import org.openapitools.client.model.ProblemDetails; import java.util.UUID; @@ -107,7 +108,7 @@ public void setCustomBaseUrl(String customBaseUrl) { 403 Forbidden - */ - public okhttp3.Call getEpisodesCall(UUID seriesId, UUID userId, List fields, Integer season, UUID seasonId, Boolean isMissing, String adjacentTo, UUID startItemId, Integer startIndex, Integer limit, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, String sortBy, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getEpisodesCall(UUID seriesId, UUID userId, List fields, Integer season, UUID seasonId, Boolean isMissing, UUID adjacentTo, UUID startItemId, Integer startIndex, Integer limit, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, ItemSortBy sortBy, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -211,7 +212,7 @@ public okhttp3.Call getEpisodesCall(UUID seriesId, UUID userId, List } @SuppressWarnings("rawtypes") - private okhttp3.Call getEpisodesValidateBeforeCall(UUID seriesId, UUID userId, List fields, Integer season, UUID seasonId, Boolean isMissing, String adjacentTo, UUID startItemId, Integer startIndex, Integer limit, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, String sortBy, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getEpisodesValidateBeforeCall(UUID seriesId, UUID userId, List fields, Integer season, UUID seasonId, Boolean isMissing, UUID adjacentTo, UUID startItemId, Integer startIndex, Integer limit, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, ItemSortBy sortBy, final ApiCallback _callback) throws ApiException { // verify the required parameter 'seriesId' is set if (seriesId == null) { throw new ApiException("Missing the required parameter 'seriesId' when calling getEpisodes(Async)"); @@ -251,7 +252,7 @@ private okhttp3.Call getEpisodesValidateBeforeCall(UUID seriesId, UUID userId, L 403 Forbidden - */ - public BaseItemDtoQueryResult getEpisodes(UUID seriesId, UUID userId, List fields, Integer season, UUID seasonId, Boolean isMissing, String adjacentTo, UUID startItemId, Integer startIndex, Integer limit, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, String sortBy) throws ApiException { + public BaseItemDtoQueryResult getEpisodes(UUID seriesId, UUID userId, List fields, Integer season, UUID seasonId, Boolean isMissing, UUID adjacentTo, UUID startItemId, Integer startIndex, Integer limit, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, ItemSortBy sortBy) throws ApiException { ApiResponse localVarResp = getEpisodesWithHttpInfo(seriesId, userId, fields, season, seasonId, isMissing, adjacentTo, startItemId, startIndex, limit, enableImages, imageTypeLimit, enableImageTypes, enableUserData, sortBy); return localVarResp.getData(); } @@ -286,7 +287,7 @@ public BaseItemDtoQueryResult getEpisodes(UUID seriesId, UUID userId, List 403 Forbidden - */ - public ApiResponse getEpisodesWithHttpInfo(UUID seriesId, UUID userId, List fields, Integer season, UUID seasonId, Boolean isMissing, String adjacentTo, UUID startItemId, Integer startIndex, Integer limit, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, String sortBy) throws ApiException { + public ApiResponse getEpisodesWithHttpInfo(UUID seriesId, UUID userId, List fields, Integer season, UUID seasonId, Boolean isMissing, UUID adjacentTo, UUID startItemId, Integer startIndex, Integer limit, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, ItemSortBy sortBy) throws ApiException { okhttp3.Call localVarCall = getEpisodesValidateBeforeCall(seriesId, userId, fields, season, seasonId, isMissing, adjacentTo, startItemId, startIndex, limit, enableImages, imageTypeLimit, enableImageTypes, enableUserData, sortBy, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); @@ -323,7 +324,7 @@ public ApiResponse getEpisodesWithHttpInfo(UUID seriesId 403 Forbidden - */ - public okhttp3.Call getEpisodesAsync(UUID seriesId, UUID userId, List fields, Integer season, UUID seasonId, Boolean isMissing, String adjacentTo, UUID startItemId, Integer startIndex, Integer limit, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, String sortBy, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getEpisodesAsync(UUID seriesId, UUID userId, List fields, Integer season, UUID seasonId, Boolean isMissing, UUID adjacentTo, UUID startItemId, Integer startIndex, Integer limit, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, ItemSortBy sortBy, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getEpisodesValidateBeforeCall(seriesId, userId, fields, season, seasonId, isMissing, adjacentTo, startItemId, startIndex, limit, enableImages, imageTypeLimit, enableImageTypes, enableUserData, sortBy, _callback); Type localVarReturnType = new TypeToken(){}.getType(); @@ -345,7 +346,8 @@ public okhttp3.Call getEpisodesAsync(UUID seriesId, UUID userId, List 403 Forbidden - */ - public okhttp3.Call getNextUpCall(UUID userId, Integer startIndex, Integer limit, List fields, String seriesId, UUID parentId, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, OffsetDateTime nextUpDateCutoff, Boolean enableTotalRecordCount, Boolean disableFirstEpisode, Boolean enableRewatching, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getNextUpCall(UUID userId, Integer startIndex, Integer limit, List fields, UUID seriesId, UUID parentId, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, OffsetDateTime nextUpDateCutoff, Boolean enableTotalRecordCount, Boolean disableFirstEpisode, Boolean enableResumable, Boolean enableRewatching, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -435,6 +437,10 @@ public okhttp3.Call getNextUpCall(UUID userId, Integer startIndex, Integer limit localVarQueryParams.addAll(localVarApiClient.parameterToPair("disableFirstEpisode", disableFirstEpisode)); } + if (enableResumable != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableResumable", enableResumable)); + } + if (enableRewatching != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableRewatching", enableRewatching)); } @@ -461,8 +467,8 @@ public okhttp3.Call getNextUpCall(UUID userId, Integer startIndex, Integer limit } @SuppressWarnings("rawtypes") - private okhttp3.Call getNextUpValidateBeforeCall(UUID userId, Integer startIndex, Integer limit, List fields, String seriesId, UUID parentId, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, OffsetDateTime nextUpDateCutoff, Boolean enableTotalRecordCount, Boolean disableFirstEpisode, Boolean enableRewatching, final ApiCallback _callback) throws ApiException { - return getNextUpCall(userId, startIndex, limit, fields, seriesId, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData, nextUpDateCutoff, enableTotalRecordCount, disableFirstEpisode, enableRewatching, _callback); + private okhttp3.Call getNextUpValidateBeforeCall(UUID userId, Integer startIndex, Integer limit, List fields, UUID seriesId, UUID parentId, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, OffsetDateTime nextUpDateCutoff, Boolean enableTotalRecordCount, Boolean disableFirstEpisode, Boolean enableResumable, Boolean enableRewatching, final ApiCallback _callback) throws ApiException { + return getNextUpCall(userId, startIndex, limit, fields, seriesId, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData, nextUpDateCutoff, enableTotalRecordCount, disableFirstEpisode, enableResumable, enableRewatching, _callback); } @@ -482,7 +488,8 @@ private okhttp3.Call getNextUpValidateBeforeCall(UUID userId, Integer startIndex * @param nextUpDateCutoff Optional. Starting date of shows to show in Next Up section. (optional) * @param enableTotalRecordCount Whether to enable the total records count. Defaults to true. (optional, default to true) * @param disableFirstEpisode Whether to disable sending the first episode in a series as next up. (optional, default to false) - * @param enableRewatching Whether to include watched episode in next up results. (optional, default to false) + * @param enableResumable Whether to include resumable episodes in next up results. (optional, default to true) + * @param enableRewatching Whether to include watched episodes in next up results. (optional, default to false) * @return BaseItemDtoQueryResult * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -494,8 +501,8 @@ private okhttp3.Call getNextUpValidateBeforeCall(UUID userId, Integer startIndex 403 Forbidden - */ - public BaseItemDtoQueryResult getNextUp(UUID userId, Integer startIndex, Integer limit, List fields, String seriesId, UUID parentId, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, OffsetDateTime nextUpDateCutoff, Boolean enableTotalRecordCount, Boolean disableFirstEpisode, Boolean enableRewatching) throws ApiException { - ApiResponse localVarResp = getNextUpWithHttpInfo(userId, startIndex, limit, fields, seriesId, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData, nextUpDateCutoff, enableTotalRecordCount, disableFirstEpisode, enableRewatching); + public BaseItemDtoQueryResult getNextUp(UUID userId, Integer startIndex, Integer limit, List fields, UUID seriesId, UUID parentId, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, OffsetDateTime nextUpDateCutoff, Boolean enableTotalRecordCount, Boolean disableFirstEpisode, Boolean enableResumable, Boolean enableRewatching) throws ApiException { + ApiResponse localVarResp = getNextUpWithHttpInfo(userId, startIndex, limit, fields, seriesId, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData, nextUpDateCutoff, enableTotalRecordCount, disableFirstEpisode, enableResumable, enableRewatching); return localVarResp.getData(); } @@ -515,7 +522,8 @@ public BaseItemDtoQueryResult getNextUp(UUID userId, Integer startIndex, Integer * @param nextUpDateCutoff Optional. Starting date of shows to show in Next Up section. (optional) * @param enableTotalRecordCount Whether to enable the total records count. Defaults to true. (optional, default to true) * @param disableFirstEpisode Whether to disable sending the first episode in a series as next up. (optional, default to false) - * @param enableRewatching Whether to include watched episode in next up results. (optional, default to false) + * @param enableResumable Whether to include resumable episodes in next up results. (optional, default to true) + * @param enableRewatching Whether to include watched episodes in next up results. (optional, default to false) * @return ApiResponse<BaseItemDtoQueryResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -527,8 +535,8 @@ public BaseItemDtoQueryResult getNextUp(UUID userId, Integer startIndex, Integer 403 Forbidden - */ - public ApiResponse getNextUpWithHttpInfo(UUID userId, Integer startIndex, Integer limit, List fields, String seriesId, UUID parentId, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, OffsetDateTime nextUpDateCutoff, Boolean enableTotalRecordCount, Boolean disableFirstEpisode, Boolean enableRewatching) throws ApiException { - okhttp3.Call localVarCall = getNextUpValidateBeforeCall(userId, startIndex, limit, fields, seriesId, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData, nextUpDateCutoff, enableTotalRecordCount, disableFirstEpisode, enableRewatching, null); + public ApiResponse getNextUpWithHttpInfo(UUID userId, Integer startIndex, Integer limit, List fields, UUID seriesId, UUID parentId, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, OffsetDateTime nextUpDateCutoff, Boolean enableTotalRecordCount, Boolean disableFirstEpisode, Boolean enableResumable, Boolean enableRewatching) throws ApiException { + okhttp3.Call localVarCall = getNextUpValidateBeforeCall(userId, startIndex, limit, fields, seriesId, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData, nextUpDateCutoff, enableTotalRecordCount, disableFirstEpisode, enableResumable, enableRewatching, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -549,7 +557,8 @@ public ApiResponse getNextUpWithHttpInfo(UUID userId, In * @param nextUpDateCutoff Optional. Starting date of shows to show in Next Up section. (optional) * @param enableTotalRecordCount Whether to enable the total records count. Defaults to true. (optional, default to true) * @param disableFirstEpisode Whether to disable sending the first episode in a series as next up. (optional, default to false) - * @param enableRewatching Whether to include watched episode in next up results. (optional, default to false) + * @param enableResumable Whether to include resumable episodes in next up results. (optional, default to true) + * @param enableRewatching Whether to include watched episodes in next up results. (optional, default to false) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -562,9 +571,9 @@ public ApiResponse getNextUpWithHttpInfo(UUID userId, In 403 Forbidden - */ - public okhttp3.Call getNextUpAsync(UUID userId, Integer startIndex, Integer limit, List fields, String seriesId, UUID parentId, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, OffsetDateTime nextUpDateCutoff, Boolean enableTotalRecordCount, Boolean disableFirstEpisode, Boolean enableRewatching, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getNextUpAsync(UUID userId, Integer startIndex, Integer limit, List fields, UUID seriesId, UUID parentId, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, OffsetDateTime nextUpDateCutoff, Boolean enableTotalRecordCount, Boolean disableFirstEpisode, Boolean enableResumable, Boolean enableRewatching, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getNextUpValidateBeforeCall(userId, startIndex, limit, fields, seriesId, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData, nextUpDateCutoff, enableTotalRecordCount, disableFirstEpisode, enableRewatching, _callback); + okhttp3.Call localVarCall = getNextUpValidateBeforeCall(userId, startIndex, limit, fields, seriesId, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData, nextUpDateCutoff, enableTotalRecordCount, disableFirstEpisode, enableResumable, enableRewatching, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -594,7 +603,7 @@ public okhttp3.Call getNextUpAsync(UUID userId, Integer startIndex, Integer limi 403 Forbidden - */ - public okhttp3.Call getSeasonsCall(UUID seriesId, UUID userId, List fields, Boolean isSpecialSeason, Boolean isMissing, String adjacentTo, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getSeasonsCall(UUID seriesId, UUID userId, List fields, Boolean isSpecialSeason, Boolean isMissing, UUID adjacentTo, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -678,7 +687,7 @@ public okhttp3.Call getSeasonsCall(UUID seriesId, UUID userId, List } @SuppressWarnings("rawtypes") - private okhttp3.Call getSeasonsValidateBeforeCall(UUID seriesId, UUID userId, List fields, Boolean isSpecialSeason, Boolean isMissing, String adjacentTo, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getSeasonsValidateBeforeCall(UUID seriesId, UUID userId, List fields, Boolean isSpecialSeason, Boolean isMissing, UUID adjacentTo, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, final ApiCallback _callback) throws ApiException { // verify the required parameter 'seriesId' is set if (seriesId == null) { throw new ApiException("Missing the required parameter 'seriesId' when calling getSeasons(Async)"); @@ -713,7 +722,7 @@ private okhttp3.Call getSeasonsValidateBeforeCall(UUID seriesId, UUID userId, Li 403 Forbidden - */ - public BaseItemDtoQueryResult getSeasons(UUID seriesId, UUID userId, List fields, Boolean isSpecialSeason, Boolean isMissing, String adjacentTo, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData) throws ApiException { + public BaseItemDtoQueryResult getSeasons(UUID seriesId, UUID userId, List fields, Boolean isSpecialSeason, Boolean isMissing, UUID adjacentTo, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData) throws ApiException { ApiResponse localVarResp = getSeasonsWithHttpInfo(seriesId, userId, fields, isSpecialSeason, isMissing, adjacentTo, enableImages, imageTypeLimit, enableImageTypes, enableUserData); return localVarResp.getData(); } @@ -743,7 +752,7 @@ public BaseItemDtoQueryResult getSeasons(UUID seriesId, UUID userId, List 403 Forbidden - */ - public ApiResponse getSeasonsWithHttpInfo(UUID seriesId, UUID userId, List fields, Boolean isSpecialSeason, Boolean isMissing, String adjacentTo, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData) throws ApiException { + public ApiResponse getSeasonsWithHttpInfo(UUID seriesId, UUID userId, List fields, Boolean isSpecialSeason, Boolean isMissing, UUID adjacentTo, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData) throws ApiException { okhttp3.Call localVarCall = getSeasonsValidateBeforeCall(seriesId, userId, fields, isSpecialSeason, isMissing, adjacentTo, enableImages, imageTypeLimit, enableImageTypes, enableUserData, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); @@ -775,7 +784,7 @@ public ApiResponse getSeasonsWithHttpInfo(UUID seriesId, 403 Forbidden - */ - public okhttp3.Call getSeasonsAsync(UUID seriesId, UUID userId, List fields, Boolean isSpecialSeason, Boolean isMissing, String adjacentTo, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getSeasonsAsync(UUID seriesId, UUID userId, List fields, Boolean isSpecialSeason, Boolean isMissing, UUID adjacentTo, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getSeasonsValidateBeforeCall(seriesId, userId, fields, isSpecialSeason, isMissing, adjacentTo, enableImages, imageTypeLimit, enableImageTypes, enableUserData, _callback); Type localVarReturnType = new TypeToken(){}.getType(); diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/UniversalAudioApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/UniversalAudioApi.java similarity index 87% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/UniversalAudioApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/UniversalAudioApi.java index 9a06470f76065..a641112f112c5 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/UniversalAudioApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/UniversalAudioApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -28,6 +28,8 @@ import java.io.File; +import org.openapitools.client.model.MediaStreamProtocol; +import org.openapitools.client.model.ProblemDetails; import java.util.UUID; import java.lang.reflect.Type; @@ -91,6 +93,7 @@ public void setCustomBaseUrl(String customBaseUrl) { * @param maxAudioSampleRate Optional. The maximum audio sample rate. (optional) * @param maxAudioBitDepth Optional. The maximum audio bit depth. (optional) * @param enableRemoteMedia Optional. Whether to enable remote media. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param breakOnNonKeyFrames Optional. Whether to break on non key frames. (optional, default to false) * @param enableRedirection Whether to enable redirection. Defaults to true. (optional, default to true) * @param _callback Callback for upload/download progress @@ -102,11 +105,12 @@ public void setCustomBaseUrl(String customBaseUrl) { Status Code Description Response Headers 200 Audio stream returned. - 302 Redirected to remote audio stream. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call getUniversalAudioStreamCall(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, String transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean breakOnNonKeyFrames, Boolean enableRedirection, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getUniversalAudioStreamCall(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, MediaStreamProtocol transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean enableAudioVbrEncoding, Boolean breakOnNonKeyFrames, Boolean enableRedirection, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -192,6 +196,10 @@ public okhttp3.Call getUniversalAudioStreamCall(UUID itemId, List contai localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableRemoteMedia", enableRemoteMedia)); } + if (enableAudioVbrEncoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAudioVbrEncoding", enableAudioVbrEncoding)); + } + if (breakOnNonKeyFrames != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("breakOnNonKeyFrames", breakOnNonKeyFrames)); } @@ -201,7 +209,10 @@ public okhttp3.Call getUniversalAudioStreamCall(UUID itemId, List contai } final String[] localVarAccepts = { - "audio/*" + "audio/*", + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -220,13 +231,13 @@ public okhttp3.Call getUniversalAudioStreamCall(UUID itemId, List contai } @SuppressWarnings("rawtypes") - private okhttp3.Call getUniversalAudioStreamValidateBeforeCall(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, String transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean breakOnNonKeyFrames, Boolean enableRedirection, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getUniversalAudioStreamValidateBeforeCall(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, MediaStreamProtocol transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean enableAudioVbrEncoding, Boolean breakOnNonKeyFrames, Boolean enableRedirection, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getUniversalAudioStream(Async)"); } - return getUniversalAudioStreamCall(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, breakOnNonKeyFrames, enableRedirection, _callback); + return getUniversalAudioStreamCall(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, enableAudioVbrEncoding, breakOnNonKeyFrames, enableRedirection, _callback); } @@ -249,6 +260,7 @@ private okhttp3.Call getUniversalAudioStreamValidateBeforeCall(UUID itemId, List * @param maxAudioSampleRate Optional. The maximum audio sample rate. (optional) * @param maxAudioBitDepth Optional. The maximum audio bit depth. (optional) * @param enableRemoteMedia Optional. Whether to enable remote media. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param breakOnNonKeyFrames Optional. Whether to break on non key frames. (optional, default to false) * @param enableRedirection Whether to enable redirection. Defaults to true. (optional, default to true) * @return File @@ -259,12 +271,13 @@ private okhttp3.Call getUniversalAudioStreamValidateBeforeCall(UUID itemId, List Status Code Description Response Headers 200 Audio stream returned. - 302 Redirected to remote audio stream. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public File getUniversalAudioStream(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, String transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean breakOnNonKeyFrames, Boolean enableRedirection) throws ApiException { - ApiResponse localVarResp = getUniversalAudioStreamWithHttpInfo(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, breakOnNonKeyFrames, enableRedirection); + public File getUniversalAudioStream(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, MediaStreamProtocol transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean enableAudioVbrEncoding, Boolean breakOnNonKeyFrames, Boolean enableRedirection) throws ApiException { + ApiResponse localVarResp = getUniversalAudioStreamWithHttpInfo(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, enableAudioVbrEncoding, breakOnNonKeyFrames, enableRedirection); return localVarResp.getData(); } @@ -287,6 +300,7 @@ public File getUniversalAudioStream(UUID itemId, List container, String * @param maxAudioSampleRate Optional. The maximum audio sample rate. (optional) * @param maxAudioBitDepth Optional. The maximum audio bit depth. (optional) * @param enableRemoteMedia Optional. Whether to enable remote media. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param breakOnNonKeyFrames Optional. Whether to break on non key frames. (optional, default to false) * @param enableRedirection Whether to enable redirection. Defaults to true. (optional, default to true) * @return ApiResponse<File> @@ -297,12 +311,13 @@ public File getUniversalAudioStream(UUID itemId, List container, String Status Code Description Response Headers 200 Audio stream returned. - 302 Redirected to remote audio stream. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public ApiResponse getUniversalAudioStreamWithHttpInfo(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, String transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean breakOnNonKeyFrames, Boolean enableRedirection) throws ApiException { - okhttp3.Call localVarCall = getUniversalAudioStreamValidateBeforeCall(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, breakOnNonKeyFrames, enableRedirection, null); + public ApiResponse getUniversalAudioStreamWithHttpInfo(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, MediaStreamProtocol transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean enableAudioVbrEncoding, Boolean breakOnNonKeyFrames, Boolean enableRedirection) throws ApiException { + okhttp3.Call localVarCall = getUniversalAudioStreamValidateBeforeCall(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, enableAudioVbrEncoding, breakOnNonKeyFrames, enableRedirection, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -326,6 +341,7 @@ public ApiResponse getUniversalAudioStreamWithHttpInfo(UUID itemId, List getUniversalAudioStreamWithHttpInfo(UUID itemId, List Status Code Description Response Headers 200 Audio stream returned. - 302 Redirected to remote audio stream. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call getUniversalAudioStreamAsync(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, String transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean breakOnNonKeyFrames, Boolean enableRedirection, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getUniversalAudioStreamAsync(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, MediaStreamProtocol transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean enableAudioVbrEncoding, Boolean breakOnNonKeyFrames, Boolean enableRedirection, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getUniversalAudioStreamValidateBeforeCall(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, breakOnNonKeyFrames, enableRedirection, _callback); + okhttp3.Call localVarCall = getUniversalAudioStreamValidateBeforeCall(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, enableAudioVbrEncoding, breakOnNonKeyFrames, enableRedirection, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -366,6 +383,7 @@ public okhttp3.Call getUniversalAudioStreamAsync(UUID itemId, List conta * @param maxAudioSampleRate Optional. The maximum audio sample rate. (optional) * @param maxAudioBitDepth Optional. The maximum audio bit depth. (optional) * @param enableRemoteMedia Optional. Whether to enable remote media. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param breakOnNonKeyFrames Optional. Whether to break on non key frames. (optional, default to false) * @param enableRedirection Whether to enable redirection. Defaults to true. (optional, default to true) * @param _callback Callback for upload/download progress @@ -377,11 +395,12 @@ public okhttp3.Call getUniversalAudioStreamAsync(UUID itemId, List conta Status Code Description Response Headers 200 Audio stream returned. - 302 Redirected to remote audio stream. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call headUniversalAudioStreamCall(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, String transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean breakOnNonKeyFrames, Boolean enableRedirection, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headUniversalAudioStreamCall(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, MediaStreamProtocol transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean enableAudioVbrEncoding, Boolean breakOnNonKeyFrames, Boolean enableRedirection, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -467,6 +486,10 @@ public okhttp3.Call headUniversalAudioStreamCall(UUID itemId, List conta localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableRemoteMedia", enableRemoteMedia)); } + if (enableAudioVbrEncoding != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("enableAudioVbrEncoding", enableAudioVbrEncoding)); + } + if (breakOnNonKeyFrames != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("breakOnNonKeyFrames", breakOnNonKeyFrames)); } @@ -476,7 +499,10 @@ public okhttp3.Call headUniversalAudioStreamCall(UUID itemId, List conta } final String[] localVarAccepts = { - "audio/*" + "audio/*", + "application/json", + "application/json; profile=CamelCase", + "application/json; profile=PascalCase" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -495,13 +521,13 @@ public okhttp3.Call headUniversalAudioStreamCall(UUID itemId, List conta } @SuppressWarnings("rawtypes") - private okhttp3.Call headUniversalAudioStreamValidateBeforeCall(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, String transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean breakOnNonKeyFrames, Boolean enableRedirection, final ApiCallback _callback) throws ApiException { + private okhttp3.Call headUniversalAudioStreamValidateBeforeCall(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, MediaStreamProtocol transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean enableAudioVbrEncoding, Boolean breakOnNonKeyFrames, Boolean enableRedirection, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling headUniversalAudioStream(Async)"); } - return headUniversalAudioStreamCall(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, breakOnNonKeyFrames, enableRedirection, _callback); + return headUniversalAudioStreamCall(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, enableAudioVbrEncoding, breakOnNonKeyFrames, enableRedirection, _callback); } @@ -524,6 +550,7 @@ private okhttp3.Call headUniversalAudioStreamValidateBeforeCall(UUID itemId, Lis * @param maxAudioSampleRate Optional. The maximum audio sample rate. (optional) * @param maxAudioBitDepth Optional. The maximum audio bit depth. (optional) * @param enableRemoteMedia Optional. Whether to enable remote media. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param breakOnNonKeyFrames Optional. Whether to break on non key frames. (optional, default to false) * @param enableRedirection Whether to enable redirection. Defaults to true. (optional, default to true) * @return File @@ -534,12 +561,13 @@ private okhttp3.Call headUniversalAudioStreamValidateBeforeCall(UUID itemId, Lis Status Code Description Response Headers 200 Audio stream returned. - 302 Redirected to remote audio stream. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public File headUniversalAudioStream(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, String transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean breakOnNonKeyFrames, Boolean enableRedirection) throws ApiException { - ApiResponse localVarResp = headUniversalAudioStreamWithHttpInfo(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, breakOnNonKeyFrames, enableRedirection); + public File headUniversalAudioStream(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, MediaStreamProtocol transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean enableAudioVbrEncoding, Boolean breakOnNonKeyFrames, Boolean enableRedirection) throws ApiException { + ApiResponse localVarResp = headUniversalAudioStreamWithHttpInfo(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, enableAudioVbrEncoding, breakOnNonKeyFrames, enableRedirection); return localVarResp.getData(); } @@ -562,6 +590,7 @@ public File headUniversalAudioStream(UUID itemId, List container, String * @param maxAudioSampleRate Optional. The maximum audio sample rate. (optional) * @param maxAudioBitDepth Optional. The maximum audio bit depth. (optional) * @param enableRemoteMedia Optional. Whether to enable remote media. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param breakOnNonKeyFrames Optional. Whether to break on non key frames. (optional, default to false) * @param enableRedirection Whether to enable redirection. Defaults to true. (optional, default to true) * @return ApiResponse<File> @@ -572,12 +601,13 @@ public File headUniversalAudioStream(UUID itemId, List container, String Status Code Description Response Headers 200 Audio stream returned. - 302 Redirected to remote audio stream. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public ApiResponse headUniversalAudioStreamWithHttpInfo(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, String transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean breakOnNonKeyFrames, Boolean enableRedirection) throws ApiException { - okhttp3.Call localVarCall = headUniversalAudioStreamValidateBeforeCall(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, breakOnNonKeyFrames, enableRedirection, null); + public ApiResponse headUniversalAudioStreamWithHttpInfo(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, MediaStreamProtocol transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean enableAudioVbrEncoding, Boolean breakOnNonKeyFrames, Boolean enableRedirection) throws ApiException { + okhttp3.Call localVarCall = headUniversalAudioStreamValidateBeforeCall(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, enableAudioVbrEncoding, breakOnNonKeyFrames, enableRedirection, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -601,6 +631,7 @@ public ApiResponse headUniversalAudioStreamWithHttpInfo(UUID itemId, List< * @param maxAudioSampleRate Optional. The maximum audio sample rate. (optional) * @param maxAudioBitDepth Optional. The maximum audio bit depth. (optional) * @param enableRemoteMedia Optional. Whether to enable remote media. (optional) + * @param enableAudioVbrEncoding Optional. Whether to enable Audio Encoding. (optional, default to true) * @param breakOnNonKeyFrames Optional. Whether to break on non key frames. (optional, default to false) * @param enableRedirection Whether to enable redirection. Defaults to true. (optional, default to true) * @param _callback The callback to be executed when the API call finishes @@ -612,13 +643,14 @@ public ApiResponse headUniversalAudioStreamWithHttpInfo(UUID itemId, List< Status Code Description Response Headers 200 Audio stream returned. - 302 Redirected to remote audio stream. - + 404 Item not found. - 401 Unauthorized - 403 Forbidden - */ - public okhttp3.Call headUniversalAudioStreamAsync(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, String transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean breakOnNonKeyFrames, Boolean enableRedirection, final ApiCallback _callback) throws ApiException { + public okhttp3.Call headUniversalAudioStreamAsync(UUID itemId, List container, String mediaSourceId, String deviceId, UUID userId, String audioCodec, Integer maxAudioChannels, Integer transcodingAudioChannels, Integer maxStreamingBitrate, Integer audioBitRate, Long startTimeTicks, String transcodingContainer, MediaStreamProtocol transcodingProtocol, Integer maxAudioSampleRate, Integer maxAudioBitDepth, Boolean enableRemoteMedia, Boolean enableAudioVbrEncoding, Boolean breakOnNonKeyFrames, Boolean enableRedirection, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = headUniversalAudioStreamValidateBeforeCall(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, breakOnNonKeyFrames, enableRedirection, _callback); + okhttp3.Call localVarCall = headUniversalAudioStreamValidateBeforeCall(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, enableAudioVbrEncoding, breakOnNonKeyFrames, enableRedirection, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/UserApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/UserApi.java similarity index 81% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/UserApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/UserApi.java index 7bceb947bdc1b..fa89595675a33 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/UserApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/UserApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -37,7 +37,6 @@ import org.openapitools.client.model.ProblemDetails; import org.openapitools.client.model.QuickConnectDto; import java.util.UUID; -import org.openapitools.client.model.UpdateUserEasyPassword; import org.openapitools.client.model.UpdateUserPassword; import org.openapitools.client.model.UserConfiguration; import org.openapitools.client.model.UserDto; @@ -86,164 +85,6 @@ public void setCustomBaseUrl(String customBaseUrl) { this.localCustomBaseUrl = customBaseUrl; } - /** - * Build call for authenticateUser - * @param userId The user id. (required) - * @param pw The password as plain text. (required) - * @param password The password sha1-hash. (optional) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
200 User authenticated. -
403 Sha1-hashed password only is not allowed. -
404 User not found. -
- */ - public okhttp3.Call authenticateUserCall(UUID userId, String pw, String password, final ApiCallback _callback) throws ApiException { - String basePath = null; - // Operation Servers - String[] localBasePaths = new String[] { }; - - // Determine Base Path to Use - if (localCustomBaseUrl != null){ - basePath = localCustomBaseUrl; - } else if ( localBasePaths.length > 0 ) { - basePath = localBasePaths[localHostIndex]; - } else { - basePath = null; - } - - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/Users/{userId}/Authenticate" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())); - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - - if (pw != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("pw", pw)); - } - - if (password != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("password", password)); - } - - final String[] localVarAccepts = { - "application/json", - "application/json; profile=CamelCase", - "application/json; profile=PascalCase" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - if (localVarContentType != null) { - localVarHeaderParams.put("Content-Type", localVarContentType); - } - - String[] localVarAuthNames = new String[] { }; - return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call authenticateUserValidateBeforeCall(UUID userId, String pw, String password, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling authenticateUser(Async)"); - } - - // verify the required parameter 'pw' is set - if (pw == null) { - throw new ApiException("Missing the required parameter 'pw' when calling authenticateUser(Async)"); - } - - return authenticateUserCall(userId, pw, password, _callback); - - } - - /** - * Authenticates a user. - * - * @param userId The user id. (required) - * @param pw The password as plain text. (required) - * @param password The password sha1-hash. (optional) - * @return AuthenticationResult - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
200 User authenticated. -
403 Sha1-hashed password only is not allowed. -
404 User not found. -
- */ - public AuthenticationResult authenticateUser(UUID userId, String pw, String password) throws ApiException { - ApiResponse localVarResp = authenticateUserWithHttpInfo(userId, pw, password); - return localVarResp.getData(); - } - - /** - * Authenticates a user. - * - * @param userId The user id. (required) - * @param pw The password as plain text. (required) - * @param password The password sha1-hash. (optional) - * @return ApiResponse<AuthenticationResult> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
200 User authenticated. -
403 Sha1-hashed password only is not allowed. -
404 User not found. -
- */ - public ApiResponse authenticateUserWithHttpInfo(UUID userId, String pw, String password) throws ApiException { - okhttp3.Call localVarCall = authenticateUserValidateBeforeCall(userId, pw, password, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Authenticates a user. (asynchronously) - * - * @param userId The user id. (required) - * @param pw The password as plain text. (required) - * @param password The password sha1-hash. (optional) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - - - -
Response Details
Status Code Description Response Headers
200 User authenticated. -
403 Sha1-hashed password only is not allowed. -
404 User not found. -
- */ - public okhttp3.Call authenticateUserAsync(UUID userId, String pw, String password, final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = authenticateUserValidateBeforeCall(userId, pw, password, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } /** * Build call for authenticateUserByName * @param authenticateUserByName The M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName) request. (required) @@ -1584,8 +1425,8 @@ public okhttp3.Call getUsersAsync(Boolean isHidden, Boolean isDisabled, final Ap } /** * Build call for updateUser - * @param userId The user id. (required) * @param userDto The updated user model. (required) + * @param userId The user id. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -1599,7 +1440,7 @@ public okhttp3.Call getUsersAsync(Boolean isHidden, Boolean isDisabled, final Ap 401 Unauthorized - */ - public okhttp3.Call updateUserCall(UUID userId, UserDto userDto, final ApiCallback _callback) throws ApiException { + public okhttp3.Call updateUserCall(UserDto userDto, UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1616,8 +1457,7 @@ public okhttp3.Call updateUserCall(UUID userId, UserDto userDto, final ApiCallba Object localVarPostBody = userDto; // create path and map variables - String localVarPath = "/Users/{userId}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())); + String localVarPath = "/Users"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -1625,6 +1465,10 @@ public okhttp3.Call updateUserCall(UUID userId, UserDto userDto, final ApiCallba Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -1650,26 +1494,21 @@ public okhttp3.Call updateUserCall(UUID userId, UserDto userDto, final ApiCallba } @SuppressWarnings("rawtypes") - private okhttp3.Call updateUserValidateBeforeCall(UUID userId, UserDto userDto, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling updateUser(Async)"); - } - + private okhttp3.Call updateUserValidateBeforeCall(UserDto userDto, UUID userId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'userDto' is set if (userDto == null) { throw new ApiException("Missing the required parameter 'userDto' when calling updateUser(Async)"); } - return updateUserCall(userId, userDto, _callback); + return updateUserCall(userDto, userId, _callback); } /** * Updates a user. * - * @param userId The user id. (required) * @param userDto The updated user model. (required) + * @param userId The user id. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1681,15 +1520,15 @@ private okhttp3.Call updateUserValidateBeforeCall(UUID userId, UserDto userDto,
401 Unauthorized -
*/ - public void updateUser(UUID userId, UserDto userDto) throws ApiException { - updateUserWithHttpInfo(userId, userDto); + public void updateUser(UserDto userDto, UUID userId) throws ApiException { + updateUserWithHttpInfo(userDto, userId); } /** * Updates a user. * - * @param userId The user id. (required) * @param userDto The updated user model. (required) + * @param userId The user id. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1702,16 +1541,16 @@ public void updateUser(UUID userId, UserDto userDto) throws ApiException { 401 Unauthorized - */ - public ApiResponse updateUserWithHttpInfo(UUID userId, UserDto userDto) throws ApiException { - okhttp3.Call localVarCall = updateUserValidateBeforeCall(userId, userDto, null); + public ApiResponse updateUserWithHttpInfo(UserDto userDto, UUID userId) throws ApiException { + okhttp3.Call localVarCall = updateUserValidateBeforeCall(userDto, userId, null); return localVarApiClient.execute(localVarCall); } /** * Updates a user. (asynchronously) * - * @param userId The user id. (required) * @param userDto The updated user model. (required) + * @param userId The user id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -1725,16 +1564,16 @@ public ApiResponse updateUserWithHttpInfo(UUID userId, UserDto userDto) th 401 Unauthorized - */ - public okhttp3.Call updateUserAsync(UUID userId, UserDto userDto, final ApiCallback _callback) throws ApiException { + public okhttp3.Call updateUserAsync(UserDto userDto, UUID userId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = updateUserValidateBeforeCall(userId, userDto, _callback); + okhttp3.Call localVarCall = updateUserValidateBeforeCall(userDto, userId, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } /** * Build call for updateUserConfiguration - * @param userId The user id. (required) * @param userConfiguration The new user configuration. (required) + * @param userId The user id. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -1747,7 +1586,7 @@ public okhttp3.Call updateUserAsync(UUID userId, UserDto userDto, final ApiCallb 401 Unauthorized - */ - public okhttp3.Call updateUserConfigurationCall(UUID userId, UserConfiguration userConfiguration, final ApiCallback _callback) throws ApiException { + public okhttp3.Call updateUserConfigurationCall(UserConfiguration userConfiguration, UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1764,8 +1603,7 @@ public okhttp3.Call updateUserConfigurationCall(UUID userId, UserConfiguration u Object localVarPostBody = userConfiguration; // create path and map variables - String localVarPath = "/Users/{userId}/Configuration" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())); + String localVarPath = "/Users/Configuration"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -1773,6 +1611,10 @@ public okhttp3.Call updateUserConfigurationCall(UUID userId, UserConfiguration u Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -1798,26 +1640,21 @@ public okhttp3.Call updateUserConfigurationCall(UUID userId, UserConfiguration u } @SuppressWarnings("rawtypes") - private okhttp3.Call updateUserConfigurationValidateBeforeCall(UUID userId, UserConfiguration userConfiguration, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling updateUserConfiguration(Async)"); - } - + private okhttp3.Call updateUserConfigurationValidateBeforeCall(UserConfiguration userConfiguration, UUID userId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'userConfiguration' is set if (userConfiguration == null) { throw new ApiException("Missing the required parameter 'userConfiguration' when calling updateUserConfiguration(Async)"); } - return updateUserConfigurationCall(userId, userConfiguration, _callback); + return updateUserConfigurationCall(userConfiguration, userId, _callback); } /** * Updates a user configuration. * - * @param userId The user id. (required) * @param userConfiguration The new user configuration. (required) + * @param userId The user id. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1828,15 +1665,15 @@ private okhttp3.Call updateUserConfigurationValidateBeforeCall(UUID userId, User
401 Unauthorized -
*/ - public void updateUserConfiguration(UUID userId, UserConfiguration userConfiguration) throws ApiException { - updateUserConfigurationWithHttpInfo(userId, userConfiguration); + public void updateUserConfiguration(UserConfiguration userConfiguration, UUID userId) throws ApiException { + updateUserConfigurationWithHttpInfo(userConfiguration, userId); } /** * Updates a user configuration. * - * @param userId The user id. (required) * @param userConfiguration The new user configuration. (required) + * @param userId The user id. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1848,16 +1685,16 @@ public void updateUserConfiguration(UUID userId, UserConfiguration userConfigura 401 Unauthorized - */ - public ApiResponse updateUserConfigurationWithHttpInfo(UUID userId, UserConfiguration userConfiguration) throws ApiException { - okhttp3.Call localVarCall = updateUserConfigurationValidateBeforeCall(userId, userConfiguration, null); + public ApiResponse updateUserConfigurationWithHttpInfo(UserConfiguration userConfiguration, UUID userId) throws ApiException { + okhttp3.Call localVarCall = updateUserConfigurationValidateBeforeCall(userConfiguration, userId, null); return localVarApiClient.execute(localVarCall); } /** * Updates a user configuration. (asynchronously) * - * @param userId The user id. (required) * @param userConfiguration The new user configuration. (required) + * @param userId The user id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -1870,165 +1707,16 @@ public ApiResponse updateUserConfigurationWithHttpInfo(UUID userId, UserCo 401 Unauthorized - */ - public okhttp3.Call updateUserConfigurationAsync(UUID userId, UserConfiguration userConfiguration, final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = updateUserConfigurationValidateBeforeCall(userId, userConfiguration, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); - return localVarCall; - } - /** - * Build call for updateUserEasyPassword - * @param userId The user id. (required) - * @param updateUserEasyPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserEasyPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserEasyPassword) request. (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - - - - -
Response Details
Status Code Description Response Headers
204 Password successfully reset. -
403 User is not allowed to update the password. -
404 User not found. -
401 Unauthorized -
- */ - public okhttp3.Call updateUserEasyPasswordCall(UUID userId, UpdateUserEasyPassword updateUserEasyPassword, final ApiCallback _callback) throws ApiException { - String basePath = null; - // Operation Servers - String[] localBasePaths = new String[] { }; - - // Determine Base Path to Use - if (localCustomBaseUrl != null){ - basePath = localCustomBaseUrl; - } else if ( localBasePaths.length > 0 ) { - basePath = localBasePaths[localHostIndex]; - } else { - basePath = null; - } - - Object localVarPostBody = updateUserEasyPassword; - - // create path and map variables - String localVarPath = "/Users/{userId}/EasyPassword" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())); - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - - final String[] localVarAccepts = { - "application/json", - "application/json; profile=CamelCase", - "application/json; profile=PascalCase" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - "application/json", - "text/json", - "application/*+json" - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - if (localVarContentType != null) { - localVarHeaderParams.put("Content-Type", localVarContentType); - } - - String[] localVarAuthNames = new String[] { "CustomAuthentication" }; - return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call updateUserEasyPasswordValidateBeforeCall(UUID userId, UpdateUserEasyPassword updateUserEasyPassword, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling updateUserEasyPassword(Async)"); - } - - // verify the required parameter 'updateUserEasyPassword' is set - if (updateUserEasyPassword == null) { - throw new ApiException("Missing the required parameter 'updateUserEasyPassword' when calling updateUserEasyPassword(Async)"); - } - - return updateUserEasyPasswordCall(userId, updateUserEasyPassword, _callback); - - } - - /** - * Updates a user's easy password. - * - * @param userId The user id. (required) - * @param updateUserEasyPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserEasyPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserEasyPassword) request. (required) - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - - -
Response Details
Status Code Description Response Headers
204 Password successfully reset. -
403 User is not allowed to update the password. -
404 User not found. -
401 Unauthorized -
- */ - public void updateUserEasyPassword(UUID userId, UpdateUserEasyPassword updateUserEasyPassword) throws ApiException { - updateUserEasyPasswordWithHttpInfo(userId, updateUserEasyPassword); - } + public okhttp3.Call updateUserConfigurationAsync(UserConfiguration userConfiguration, UUID userId, final ApiCallback _callback) throws ApiException { - /** - * Updates a user's easy password. - * - * @param userId The user id. (required) - * @param updateUserEasyPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserEasyPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserEasyPassword) request. (required) - * @return ApiResponse<Void> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - - -
Response Details
Status Code Description Response Headers
204 Password successfully reset. -
403 User is not allowed to update the password. -
404 User not found. -
401 Unauthorized -
- */ - public ApiResponse updateUserEasyPasswordWithHttpInfo(UUID userId, UpdateUserEasyPassword updateUserEasyPassword) throws ApiException { - okhttp3.Call localVarCall = updateUserEasyPasswordValidateBeforeCall(userId, updateUserEasyPassword, null); - return localVarApiClient.execute(localVarCall); - } - - /** - * Updates a user's easy password. (asynchronously) - * - * @param userId The user id. (required) - * @param updateUserEasyPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserEasyPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserEasyPassword) request. (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - - - - -
Response Details
Status Code Description Response Headers
204 Password successfully reset. -
403 User is not allowed to update the password. -
404 User not found. -
401 Unauthorized -
- */ - public okhttp3.Call updateUserEasyPasswordAsync(UUID userId, UpdateUserEasyPassword updateUserEasyPassword, final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = updateUserEasyPasswordValidateBeforeCall(userId, updateUserEasyPassword, _callback); + okhttp3.Call localVarCall = updateUserConfigurationValidateBeforeCall(userConfiguration, userId, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } /** * Build call for updateUserPassword - * @param userId The user id. (required) - * @param updateUserPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. (required) + * @param updateUserPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. (required) + * @param userId The user id. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -2042,7 +1730,7 @@ public okhttp3.Call updateUserEasyPasswordAsync(UUID userId, UpdateUserEasyPassw 401 Unauthorized - */ - public okhttp3.Call updateUserPasswordCall(UUID userId, UpdateUserPassword updateUserPassword, final ApiCallback _callback) throws ApiException { + public okhttp3.Call updateUserPasswordCall(UpdateUserPassword updateUserPassword, UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -2059,8 +1747,7 @@ public okhttp3.Call updateUserPasswordCall(UUID userId, UpdateUserPassword updat Object localVarPostBody = updateUserPassword; // create path and map variables - String localVarPath = "/Users/{userId}/Password" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())); + String localVarPath = "/Users/Password"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -2068,6 +1755,10 @@ public okhttp3.Call updateUserPasswordCall(UUID userId, UpdateUserPassword updat Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -2093,26 +1784,21 @@ public okhttp3.Call updateUserPasswordCall(UUID userId, UpdateUserPassword updat } @SuppressWarnings("rawtypes") - private okhttp3.Call updateUserPasswordValidateBeforeCall(UUID userId, UpdateUserPassword updateUserPassword, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling updateUserPassword(Async)"); - } - + private okhttp3.Call updateUserPasswordValidateBeforeCall(UpdateUserPassword updateUserPassword, UUID userId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'updateUserPassword' is set if (updateUserPassword == null) { throw new ApiException("Missing the required parameter 'updateUserPassword' when calling updateUserPassword(Async)"); } - return updateUserPasswordCall(userId, updateUserPassword, _callback); + return updateUserPasswordCall(updateUserPassword, userId, _callback); } /** * Updates a user's password. * - * @param userId The user id. (required) - * @param updateUserPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. (required) + * @param updateUserPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. (required) + * @param userId The user id. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2124,15 +1810,15 @@ private okhttp3.Call updateUserPasswordValidateBeforeCall(UUID userId, UpdateUse
401 Unauthorized -
*/ - public void updateUserPassword(UUID userId, UpdateUserPassword updateUserPassword) throws ApiException { - updateUserPasswordWithHttpInfo(userId, updateUserPassword); + public void updateUserPassword(UpdateUserPassword updateUserPassword, UUID userId) throws ApiException { + updateUserPasswordWithHttpInfo(updateUserPassword, userId); } /** * Updates a user's password. * - * @param userId The user id. (required) - * @param updateUserPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. (required) + * @param updateUserPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. (required) + * @param userId The user id. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2145,16 +1831,16 @@ public void updateUserPassword(UUID userId, UpdateUserPassword updateUserPasswor 401 Unauthorized - */ - public ApiResponse updateUserPasswordWithHttpInfo(UUID userId, UpdateUserPassword updateUserPassword) throws ApiException { - okhttp3.Call localVarCall = updateUserPasswordValidateBeforeCall(userId, updateUserPassword, null); + public ApiResponse updateUserPasswordWithHttpInfo(UpdateUserPassword updateUserPassword, UUID userId) throws ApiException { + okhttp3.Call localVarCall = updateUserPasswordValidateBeforeCall(updateUserPassword, userId, null); return localVarApiClient.execute(localVarCall); } /** * Updates a user's password. (asynchronously) * - * @param userId The user id. (required) - * @param updateUserPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. (required) + * @param updateUserPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. (required) + * @param userId The user id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -2168,9 +1854,9 @@ public ApiResponse updateUserPasswordWithHttpInfo(UUID userId, UpdateUserP 401 Unauthorized - */ - public okhttp3.Call updateUserPasswordAsync(UUID userId, UpdateUserPassword updateUserPassword, final ApiCallback _callback) throws ApiException { + public okhttp3.Call updateUserPasswordAsync(UpdateUserPassword updateUserPassword, UUID userId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = updateUserPasswordValidateBeforeCall(userId, updateUserPassword, _callback); + okhttp3.Call localVarCall = updateUserPasswordValidateBeforeCall(updateUserPassword, userId, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/UserLibraryApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/UserLibraryApi.java similarity index 86% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/UserLibraryApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/UserLibraryApi.java index 5ebe0525a8762..697b43431961e 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/UserLibraryApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/UserLibraryApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -80,8 +80,8 @@ public void setCustomBaseUrl(String customBaseUrl) { /** * Build call for deleteUserItemRating - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -94,7 +94,7 @@ public void setCustomBaseUrl(String customBaseUrl) { 403 Forbidden - */ - public okhttp3.Call deleteUserItemRatingCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call deleteUserItemRatingCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -111,8 +111,7 @@ public okhttp3.Call deleteUserItemRatingCall(UUID userId, UUID itemId, final Api Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/Items/{itemId}/Rating" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) + String localVarPath = "/UserItems/{itemId}/Rating" .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); @@ -121,6 +120,10 @@ public okhttp3.Call deleteUserItemRatingCall(UUID userId, UUID itemId, final Api Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -143,26 +146,21 @@ public okhttp3.Call deleteUserItemRatingCall(UUID userId, UUID itemId, final Api } @SuppressWarnings("rawtypes") - private okhttp3.Call deleteUserItemRatingValidateBeforeCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling deleteUserItemRating(Async)"); - } - + private okhttp3.Call deleteUserItemRatingValidateBeforeCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling deleteUserItemRating(Async)"); } - return deleteUserItemRatingCall(userId, itemId, _callback); + return deleteUserItemRatingCall(itemId, userId, _callback); } /** * Deletes a user's saved personal rating for an item. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return UserItemDataDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -174,16 +172,16 @@ private okhttp3.Call deleteUserItemRatingValidateBeforeCall(UUID userId, UUID it 403 Forbidden - */ - public UserItemDataDto deleteUserItemRating(UUID userId, UUID itemId) throws ApiException { - ApiResponse localVarResp = deleteUserItemRatingWithHttpInfo(userId, itemId); + public UserItemDataDto deleteUserItemRating(UUID itemId, UUID userId) throws ApiException { + ApiResponse localVarResp = deleteUserItemRatingWithHttpInfo(itemId, userId); return localVarResp.getData(); } /** * Deletes a user's saved personal rating for an item. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return ApiResponse<UserItemDataDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -195,8 +193,8 @@ public UserItemDataDto deleteUserItemRating(UUID userId, UUID itemId) throws Api 403 Forbidden - */ - public ApiResponse deleteUserItemRatingWithHttpInfo(UUID userId, UUID itemId) throws ApiException { - okhttp3.Call localVarCall = deleteUserItemRatingValidateBeforeCall(userId, itemId, null); + public ApiResponse deleteUserItemRatingWithHttpInfo(UUID itemId, UUID userId) throws ApiException { + okhttp3.Call localVarCall = deleteUserItemRatingValidateBeforeCall(itemId, userId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -204,8 +202,8 @@ public ApiResponse deleteUserItemRatingWithHttpInfo(UUID userId /** * Deletes a user's saved personal rating for an item. (asynchronously) * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -218,17 +216,17 @@ public ApiResponse deleteUserItemRatingWithHttpInfo(UUID userId 403 Forbidden - */ - public okhttp3.Call deleteUserItemRatingAsync(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call deleteUserItemRatingAsync(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = deleteUserItemRatingValidateBeforeCall(userId, itemId, _callback); + okhttp3.Call localVarCall = deleteUserItemRatingValidateBeforeCall(itemId, userId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getIntros - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -241,7 +239,7 @@ public okhttp3.Call deleteUserItemRatingAsync(UUID userId, UUID itemId, final Ap 403 Forbidden - */ - public okhttp3.Call getIntrosCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getIntrosCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -258,8 +256,7 @@ public okhttp3.Call getIntrosCall(UUID userId, UUID itemId, final ApiCallback _c Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/Items/{itemId}/Intros" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) + String localVarPath = "/Items/{itemId}/Intros" .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); @@ -268,6 +265,10 @@ public okhttp3.Call getIntrosCall(UUID userId, UUID itemId, final ApiCallback _c Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -290,26 +291,21 @@ public okhttp3.Call getIntrosCall(UUID userId, UUID itemId, final ApiCallback _c } @SuppressWarnings("rawtypes") - private okhttp3.Call getIntrosValidateBeforeCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling getIntros(Async)"); - } - + private okhttp3.Call getIntrosValidateBeforeCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getIntros(Async)"); } - return getIntrosCall(userId, itemId, _callback); + return getIntrosCall(itemId, userId, _callback); } /** * Gets intros to play before the main media item plays. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return BaseItemDtoQueryResult * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -321,16 +317,16 @@ private okhttp3.Call getIntrosValidateBeforeCall(UUID userId, UUID itemId, final 403 Forbidden - */ - public BaseItemDtoQueryResult getIntros(UUID userId, UUID itemId) throws ApiException { - ApiResponse localVarResp = getIntrosWithHttpInfo(userId, itemId); + public BaseItemDtoQueryResult getIntros(UUID itemId, UUID userId) throws ApiException { + ApiResponse localVarResp = getIntrosWithHttpInfo(itemId, userId); return localVarResp.getData(); } /** * Gets intros to play before the main media item plays. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return ApiResponse<BaseItemDtoQueryResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -342,8 +338,8 @@ public BaseItemDtoQueryResult getIntros(UUID userId, UUID itemId) throws ApiExce 403 Forbidden - */ - public ApiResponse getIntrosWithHttpInfo(UUID userId, UUID itemId) throws ApiException { - okhttp3.Call localVarCall = getIntrosValidateBeforeCall(userId, itemId, null); + public ApiResponse getIntrosWithHttpInfo(UUID itemId, UUID userId) throws ApiException { + okhttp3.Call localVarCall = getIntrosValidateBeforeCall(itemId, userId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -351,8 +347,8 @@ public ApiResponse getIntrosWithHttpInfo(UUID userId, UU /** * Gets intros to play before the main media item plays. (asynchronously) * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -365,17 +361,17 @@ public ApiResponse getIntrosWithHttpInfo(UUID userId, UU 403 Forbidden - */ - public okhttp3.Call getIntrosAsync(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getIntrosAsync(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getIntrosValidateBeforeCall(userId, itemId, _callback); + okhttp3.Call localVarCall = getIntrosValidateBeforeCall(itemId, userId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getItem - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -388,7 +384,7 @@ public okhttp3.Call getIntrosAsync(UUID userId, UUID itemId, final ApiCallback 403 Forbidden - */ - public okhttp3.Call getItemCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getItemCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -405,8 +401,7 @@ public okhttp3.Call getItemCall(UUID userId, UUID itemId, final ApiCallback _cal Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/Items/{itemId}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) + String localVarPath = "/Items/{itemId}" .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); @@ -415,6 +410,10 @@ public okhttp3.Call getItemCall(UUID userId, UUID itemId, final ApiCallback _cal Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -437,26 +436,21 @@ public okhttp3.Call getItemCall(UUID userId, UUID itemId, final ApiCallback _cal } @SuppressWarnings("rawtypes") - private okhttp3.Call getItemValidateBeforeCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling getItem(Async)"); - } - + private okhttp3.Call getItemValidateBeforeCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getItem(Async)"); } - return getItemCall(userId, itemId, _callback); + return getItemCall(itemId, userId, _callback); } /** * Gets an item from a user's library. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return BaseItemDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -468,16 +462,16 @@ private okhttp3.Call getItemValidateBeforeCall(UUID userId, UUID itemId, final A 403 Forbidden - */ - public BaseItemDto getItem(UUID userId, UUID itemId) throws ApiException { - ApiResponse localVarResp = getItemWithHttpInfo(userId, itemId); + public BaseItemDto getItem(UUID itemId, UUID userId) throws ApiException { + ApiResponse localVarResp = getItemWithHttpInfo(itemId, userId); return localVarResp.getData(); } /** * Gets an item from a user's library. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return ApiResponse<BaseItemDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -489,8 +483,8 @@ public BaseItemDto getItem(UUID userId, UUID itemId) throws ApiException { 403 Forbidden - */ - public ApiResponse getItemWithHttpInfo(UUID userId, UUID itemId) throws ApiException { - okhttp3.Call localVarCall = getItemValidateBeforeCall(userId, itemId, null); + public ApiResponse getItemWithHttpInfo(UUID itemId, UUID userId) throws ApiException { + okhttp3.Call localVarCall = getItemValidateBeforeCall(itemId, userId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -498,8 +492,8 @@ public ApiResponse getItemWithHttpInfo(UUID userId, UUID itemId) th /** * Gets an item from a user's library. (asynchronously) * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -512,16 +506,16 @@ public ApiResponse getItemWithHttpInfo(UUID userId, UUID itemId) th 403 Forbidden - */ - public okhttp3.Call getItemAsync(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getItemAsync(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getItemValidateBeforeCall(userId, itemId, _callback); + okhttp3.Call localVarCall = getItemValidateBeforeCall(itemId, userId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getLatestMedia - * @param userId User id. (required) + * @param userId User id. (optional) * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) * @param includeItemTypes Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional) @@ -561,8 +555,7 @@ public okhttp3.Call getLatestMediaCall(UUID userId, UUID parentId, List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -570,6 +563,10 @@ public okhttp3.Call getLatestMediaCall(UUID userId, UUID parentId, List localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + if (parentId != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("parentId", parentId)); } @@ -633,11 +630,6 @@ public okhttp3.Call getLatestMediaCall(UUID userId, UUID parentId, List fields, List includeItemTypes, Boolean isPlayed, Boolean enableImages, Integer imageTypeLimit, List enableImageTypes, Boolean enableUserData, Integer limit, Boolean groupItems, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling getLatestMedia(Async)"); - } - return getLatestMediaCall(userId, parentId, fields, includeItemTypes, isPlayed, enableImages, imageTypeLimit, enableImageTypes, enableUserData, limit, groupItems, _callback); } @@ -645,7 +637,7 @@ private okhttp3.Call getLatestMediaValidateBeforeCall(UUID userId, UUID parentId /** * Gets latest media. * - * @param userId User id. (required) + * @param userId User id. (optional) * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) * @param includeItemTypes Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional) @@ -675,7 +667,7 @@ public List getLatestMedia(UUID userId, UUID parentId, List> getLatestMediaWithHttpInfo(UUID userId, UU /** * Gets latest media. (asynchronously) * - * @param userId User id. (required) + * @param userId User id. (optional) * @param parentId Specify this to localize the search to a specific item or folder. Omit to use the root. (optional) * @param fields Optional. Specify additional fields of information to return in the output. (optional) * @param includeItemTypes Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. (optional) @@ -738,8 +730,8 @@ public okhttp3.Call getLatestMediaAsync(UUID userId, UUID parentId, List 403 Forbidden - */ - public okhttp3.Call getLocalTrailersCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getLocalTrailersCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -769,8 +761,7 @@ public okhttp3.Call getLocalTrailersCall(UUID userId, UUID itemId, final ApiCall Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/Items/{itemId}/LocalTrailers" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) + String localVarPath = "/Items/{itemId}/LocalTrailers" .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); @@ -779,6 +770,10 @@ public okhttp3.Call getLocalTrailersCall(UUID userId, UUID itemId, final ApiCall Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -801,26 +796,21 @@ public okhttp3.Call getLocalTrailersCall(UUID userId, UUID itemId, final ApiCall } @SuppressWarnings("rawtypes") - private okhttp3.Call getLocalTrailersValidateBeforeCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling getLocalTrailers(Async)"); - } - + private okhttp3.Call getLocalTrailersValidateBeforeCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getLocalTrailers(Async)"); } - return getLocalTrailersCall(userId, itemId, _callback); + return getLocalTrailersCall(itemId, userId, _callback); } /** * Gets local trailers for an item. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return List<BaseItemDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -832,16 +822,16 @@ private okhttp3.Call getLocalTrailersValidateBeforeCall(UUID userId, UUID itemId 403 Forbidden - */ - public List getLocalTrailers(UUID userId, UUID itemId) throws ApiException { - ApiResponse> localVarResp = getLocalTrailersWithHttpInfo(userId, itemId); + public List getLocalTrailers(UUID itemId, UUID userId) throws ApiException { + ApiResponse> localVarResp = getLocalTrailersWithHttpInfo(itemId, userId); return localVarResp.getData(); } /** * Gets local trailers for an item. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return ApiResponse<List<BaseItemDto>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -853,8 +843,8 @@ public List getLocalTrailers(UUID userId, UUID itemId) throws ApiEx 403 Forbidden - */ - public ApiResponse> getLocalTrailersWithHttpInfo(UUID userId, UUID itemId) throws ApiException { - okhttp3.Call localVarCall = getLocalTrailersValidateBeforeCall(userId, itemId, null); + public ApiResponse> getLocalTrailersWithHttpInfo(UUID itemId, UUID userId) throws ApiException { + okhttp3.Call localVarCall = getLocalTrailersValidateBeforeCall(itemId, userId, null); Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -862,8 +852,8 @@ public ApiResponse> getLocalTrailersWithHttpInfo(UUID userId, /** * Gets local trailers for an item. (asynchronously) * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -876,16 +866,16 @@ public ApiResponse> getLocalTrailersWithHttpInfo(UUID userId, 403 Forbidden - */ - public okhttp3.Call getLocalTrailersAsync(UUID userId, UUID itemId, final ApiCallback> _callback) throws ApiException { + public okhttp3.Call getLocalTrailersAsync(UUID itemId, UUID userId, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = getLocalTrailersValidateBeforeCall(userId, itemId, _callback); + okhttp3.Call localVarCall = getLocalTrailersValidateBeforeCall(itemId, userId, _callback); Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getRootFolder - * @param userId User id. (required) + * @param userId User id. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -915,8 +905,7 @@ public okhttp3.Call getRootFolderCall(UUID userId, final ApiCallback _callback) Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/Items/Root" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())); + String localVarPath = "/Items/Root"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -924,6 +913,10 @@ public okhttp3.Call getRootFolderCall(UUID userId, final ApiCallback _callback) Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -947,11 +940,6 @@ public okhttp3.Call getRootFolderCall(UUID userId, final ApiCallback _callback) @SuppressWarnings("rawtypes") private okhttp3.Call getRootFolderValidateBeforeCall(UUID userId, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling getRootFolder(Async)"); - } - return getRootFolderCall(userId, _callback); } @@ -959,7 +947,7 @@ private okhttp3.Call getRootFolderValidateBeforeCall(UUID userId, final ApiCallb /** * Gets the root folder from a user's library. * - * @param userId User id. (required) + * @param userId User id. (optional) * @return BaseItemDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -979,7 +967,7 @@ public BaseItemDto getRootFolder(UUID userId) throws ApiException { /** * Gets the root folder from a user's library. * - * @param userId User id. (required) + * @param userId User id. (optional) * @return ApiResponse<BaseItemDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1000,7 +988,7 @@ public ApiResponse getRootFolderWithHttpInfo(UUID userId) throws Ap /** * Gets the root folder from a user's library. (asynchronously) * - * @param userId User id. (required) + * @param userId User id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -1022,8 +1010,8 @@ public okhttp3.Call getRootFolderAsync(UUID userId, final ApiCallback 403 Forbidden - */ - public okhttp3.Call getSpecialFeaturesCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getSpecialFeaturesCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1053,8 +1041,7 @@ public okhttp3.Call getSpecialFeaturesCall(UUID userId, UUID itemId, final ApiCa Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/Items/{itemId}/SpecialFeatures" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) + String localVarPath = "/Items/{itemId}/SpecialFeatures" .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); @@ -1063,6 +1050,10 @@ public okhttp3.Call getSpecialFeaturesCall(UUID userId, UUID itemId, final ApiCa Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -1085,26 +1076,21 @@ public okhttp3.Call getSpecialFeaturesCall(UUID userId, UUID itemId, final ApiCa } @SuppressWarnings("rawtypes") - private okhttp3.Call getSpecialFeaturesValidateBeforeCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling getSpecialFeatures(Async)"); - } - + private okhttp3.Call getSpecialFeaturesValidateBeforeCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling getSpecialFeatures(Async)"); } - return getSpecialFeaturesCall(userId, itemId, _callback); + return getSpecialFeaturesCall(itemId, userId, _callback); } /** * Gets special features for an item. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return List<BaseItemDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1116,16 +1102,16 @@ private okhttp3.Call getSpecialFeaturesValidateBeforeCall(UUID userId, UUID item 403 Forbidden - */ - public List getSpecialFeatures(UUID userId, UUID itemId) throws ApiException { - ApiResponse> localVarResp = getSpecialFeaturesWithHttpInfo(userId, itemId); + public List getSpecialFeatures(UUID itemId, UUID userId) throws ApiException { + ApiResponse> localVarResp = getSpecialFeaturesWithHttpInfo(itemId, userId); return localVarResp.getData(); } /** * Gets special features for an item. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return ApiResponse<List<BaseItemDto>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1137,8 +1123,8 @@ public List getSpecialFeatures(UUID userId, UUID itemId) throws Api 403 Forbidden - */ - public ApiResponse> getSpecialFeaturesWithHttpInfo(UUID userId, UUID itemId) throws ApiException { - okhttp3.Call localVarCall = getSpecialFeaturesValidateBeforeCall(userId, itemId, null); + public ApiResponse> getSpecialFeaturesWithHttpInfo(UUID itemId, UUID userId) throws ApiException { + okhttp3.Call localVarCall = getSpecialFeaturesValidateBeforeCall(itemId, userId, null); Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -1146,8 +1132,8 @@ public ApiResponse> getSpecialFeaturesWithHttpInfo(UUID userId /** * Gets special features for an item. (asynchronously) * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -1160,17 +1146,17 @@ public ApiResponse> getSpecialFeaturesWithHttpInfo(UUID userId 403 Forbidden - */ - public okhttp3.Call getSpecialFeaturesAsync(UUID userId, UUID itemId, final ApiCallback> _callback) throws ApiException { + public okhttp3.Call getSpecialFeaturesAsync(UUID itemId, UUID userId, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = getSpecialFeaturesValidateBeforeCall(userId, itemId, _callback); + okhttp3.Call localVarCall = getSpecialFeaturesValidateBeforeCall(itemId, userId, _callback); Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for markFavoriteItem - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -1183,7 +1169,7 @@ public okhttp3.Call getSpecialFeaturesAsync(UUID userId, UUID itemId, final ApiC 403 Forbidden - */ - public okhttp3.Call markFavoriteItemCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call markFavoriteItemCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1200,8 +1186,7 @@ public okhttp3.Call markFavoriteItemCall(UUID userId, UUID itemId, final ApiCall Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/FavoriteItems/{itemId}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) + String localVarPath = "/UserFavoriteItems/{itemId}" .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); @@ -1210,6 +1195,10 @@ public okhttp3.Call markFavoriteItemCall(UUID userId, UUID itemId, final ApiCall Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -1232,26 +1221,21 @@ public okhttp3.Call markFavoriteItemCall(UUID userId, UUID itemId, final ApiCall } @SuppressWarnings("rawtypes") - private okhttp3.Call markFavoriteItemValidateBeforeCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling markFavoriteItem(Async)"); - } - + private okhttp3.Call markFavoriteItemValidateBeforeCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling markFavoriteItem(Async)"); } - return markFavoriteItemCall(userId, itemId, _callback); + return markFavoriteItemCall(itemId, userId, _callback); } /** * Marks an item as a favorite. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return UserItemDataDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1263,16 +1247,16 @@ private okhttp3.Call markFavoriteItemValidateBeforeCall(UUID userId, UUID itemId 403 Forbidden - */ - public UserItemDataDto markFavoriteItem(UUID userId, UUID itemId) throws ApiException { - ApiResponse localVarResp = markFavoriteItemWithHttpInfo(userId, itemId); + public UserItemDataDto markFavoriteItem(UUID itemId, UUID userId) throws ApiException { + ApiResponse localVarResp = markFavoriteItemWithHttpInfo(itemId, userId); return localVarResp.getData(); } /** * Marks an item as a favorite. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return ApiResponse<UserItemDataDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1284,8 +1268,8 @@ public UserItemDataDto markFavoriteItem(UUID userId, UUID itemId) throws ApiExce 403 Forbidden - */ - public ApiResponse markFavoriteItemWithHttpInfo(UUID userId, UUID itemId) throws ApiException { - okhttp3.Call localVarCall = markFavoriteItemValidateBeforeCall(userId, itemId, null); + public ApiResponse markFavoriteItemWithHttpInfo(UUID itemId, UUID userId) throws ApiException { + okhttp3.Call localVarCall = markFavoriteItemValidateBeforeCall(itemId, userId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -1293,8 +1277,8 @@ public ApiResponse markFavoriteItemWithHttpInfo(UUID userId, UU /** * Marks an item as a favorite. (asynchronously) * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -1307,17 +1291,17 @@ public ApiResponse markFavoriteItemWithHttpInfo(UUID userId, UU 403 Forbidden - */ - public okhttp3.Call markFavoriteItemAsync(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call markFavoriteItemAsync(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = markFavoriteItemValidateBeforeCall(userId, itemId, _callback); + okhttp3.Call localVarCall = markFavoriteItemValidateBeforeCall(itemId, userId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for unmarkFavoriteItem - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -1330,7 +1314,7 @@ public okhttp3.Call markFavoriteItemAsync(UUID userId, UUID itemId, final ApiCal 403 Forbidden - */ - public okhttp3.Call unmarkFavoriteItemCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call unmarkFavoriteItemCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1347,8 +1331,7 @@ public okhttp3.Call unmarkFavoriteItemCall(UUID userId, UUID itemId, final ApiCa Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/FavoriteItems/{itemId}" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) + String localVarPath = "/UserFavoriteItems/{itemId}" .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); @@ -1357,6 +1340,10 @@ public okhttp3.Call unmarkFavoriteItemCall(UUID userId, UUID itemId, final ApiCa Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -1379,26 +1366,21 @@ public okhttp3.Call unmarkFavoriteItemCall(UUID userId, UUID itemId, final ApiCa } @SuppressWarnings("rawtypes") - private okhttp3.Call unmarkFavoriteItemValidateBeforeCall(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling unmarkFavoriteItem(Async)"); - } - + private okhttp3.Call unmarkFavoriteItemValidateBeforeCall(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling unmarkFavoriteItem(Async)"); } - return unmarkFavoriteItemCall(userId, itemId, _callback); + return unmarkFavoriteItemCall(itemId, userId, _callback); } /** * Unmarks item as a favorite. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return UserItemDataDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1410,16 +1392,16 @@ private okhttp3.Call unmarkFavoriteItemValidateBeforeCall(UUID userId, UUID item 403 Forbidden - */ - public UserItemDataDto unmarkFavoriteItem(UUID userId, UUID itemId) throws ApiException { - ApiResponse localVarResp = unmarkFavoriteItemWithHttpInfo(userId, itemId); + public UserItemDataDto unmarkFavoriteItem(UUID itemId, UUID userId) throws ApiException { + ApiResponse localVarResp = unmarkFavoriteItemWithHttpInfo(itemId, userId); return localVarResp.getData(); } /** * Unmarks item as a favorite. * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @return ApiResponse<UserItemDataDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1431,8 +1413,8 @@ public UserItemDataDto unmarkFavoriteItem(UUID userId, UUID itemId) throws ApiEx 403 Forbidden - */ - public ApiResponse unmarkFavoriteItemWithHttpInfo(UUID userId, UUID itemId) throws ApiException { - okhttp3.Call localVarCall = unmarkFavoriteItemValidateBeforeCall(userId, itemId, null); + public ApiResponse unmarkFavoriteItemWithHttpInfo(UUID itemId, UUID userId) throws ApiException { + okhttp3.Call localVarCall = unmarkFavoriteItemValidateBeforeCall(itemId, userId, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -1440,8 +1422,8 @@ public ApiResponse unmarkFavoriteItemWithHttpInfo(UUID userId, /** * Unmarks item as a favorite. (asynchronously) * - * @param userId User id. (required) * @param itemId Item id. (required) + * @param userId User id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -1454,18 +1436,18 @@ public ApiResponse unmarkFavoriteItemWithHttpInfo(UUID userId, 403 Forbidden - */ - public okhttp3.Call unmarkFavoriteItemAsync(UUID userId, UUID itemId, final ApiCallback _callback) throws ApiException { + public okhttp3.Call unmarkFavoriteItemAsync(UUID itemId, UUID userId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = unmarkFavoriteItemValidateBeforeCall(userId, itemId, _callback); + okhttp3.Call localVarCall = unmarkFavoriteItemValidateBeforeCall(itemId, userId, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for updateUserItemRating - * @param userId User id. (required) * @param itemId Item id. (required) - * @param likes Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Guid,System.Guid,System.Nullable{System.Boolean}) is likes. (optional) + * @param userId User id. (optional) + * @param likes Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean}) is likes. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -1478,7 +1460,7 @@ public okhttp3.Call unmarkFavoriteItemAsync(UUID userId, UUID itemId, final ApiC 403 Forbidden - */ - public okhttp3.Call updateUserItemRatingCall(UUID userId, UUID itemId, Boolean likes, final ApiCallback _callback) throws ApiException { + public okhttp3.Call updateUserItemRatingCall(UUID itemId, UUID userId, Boolean likes, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -1495,8 +1477,7 @@ public okhttp3.Call updateUserItemRatingCall(UUID userId, UUID itemId, Boolean l Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/Items/{itemId}/Rating" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())) + String localVarPath = "/UserItems/{itemId}/Rating" .replace("{" + "itemId" + "}", localVarApiClient.escapeString(itemId.toString())); List localVarQueryParams = new ArrayList(); @@ -1505,6 +1486,10 @@ public okhttp3.Call updateUserItemRatingCall(UUID userId, UUID itemId, Boolean l Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + if (likes != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("likes", likes)); } @@ -1531,27 +1516,22 @@ public okhttp3.Call updateUserItemRatingCall(UUID userId, UUID itemId, Boolean l } @SuppressWarnings("rawtypes") - private okhttp3.Call updateUserItemRatingValidateBeforeCall(UUID userId, UUID itemId, Boolean likes, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling updateUserItemRating(Async)"); - } - + private okhttp3.Call updateUserItemRatingValidateBeforeCall(UUID itemId, UUID userId, Boolean likes, final ApiCallback _callback) throws ApiException { // verify the required parameter 'itemId' is set if (itemId == null) { throw new ApiException("Missing the required parameter 'itemId' when calling updateUserItemRating(Async)"); } - return updateUserItemRatingCall(userId, itemId, likes, _callback); + return updateUserItemRatingCall(itemId, userId, likes, _callback); } /** * Updates a user's rating for an item. * - * @param userId User id. (required) * @param itemId Item id. (required) - * @param likes Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Guid,System.Guid,System.Nullable{System.Boolean}) is likes. (optional) + * @param userId User id. (optional) + * @param likes Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean}) is likes. (optional) * @return UserItemDataDto * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1563,17 +1543,17 @@ private okhttp3.Call updateUserItemRatingValidateBeforeCall(UUID userId, UUID it 403 Forbidden - */ - public UserItemDataDto updateUserItemRating(UUID userId, UUID itemId, Boolean likes) throws ApiException { - ApiResponse localVarResp = updateUserItemRatingWithHttpInfo(userId, itemId, likes); + public UserItemDataDto updateUserItemRating(UUID itemId, UUID userId, Boolean likes) throws ApiException { + ApiResponse localVarResp = updateUserItemRatingWithHttpInfo(itemId, userId, likes); return localVarResp.getData(); } /** * Updates a user's rating for an item. * - * @param userId User id. (required) * @param itemId Item id. (required) - * @param likes Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Guid,System.Guid,System.Nullable{System.Boolean}) is likes. (optional) + * @param userId User id. (optional) + * @param likes Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean}) is likes. (optional) * @return ApiResponse<UserItemDataDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1585,8 +1565,8 @@ public UserItemDataDto updateUserItemRating(UUID userId, UUID itemId, Boolean li 403 Forbidden - */ - public ApiResponse updateUserItemRatingWithHttpInfo(UUID userId, UUID itemId, Boolean likes) throws ApiException { - okhttp3.Call localVarCall = updateUserItemRatingValidateBeforeCall(userId, itemId, likes, null); + public ApiResponse updateUserItemRatingWithHttpInfo(UUID itemId, UUID userId, Boolean likes) throws ApiException { + okhttp3.Call localVarCall = updateUserItemRatingValidateBeforeCall(itemId, userId, likes, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -1594,9 +1574,9 @@ public ApiResponse updateUserItemRatingWithHttpInfo(UUID userId /** * Updates a user's rating for an item. (asynchronously) * - * @param userId User id. (required) * @param itemId Item id. (required) - * @param likes Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Guid,System.Guid,System.Nullable{System.Boolean}) is likes. (optional) + * @param userId User id. (optional) + * @param likes Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean}) is likes. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -1609,9 +1589,9 @@ public ApiResponse updateUserItemRatingWithHttpInfo(UUID userId 403 Forbidden - */ - public okhttp3.Call updateUserItemRatingAsync(UUID userId, UUID itemId, Boolean likes, final ApiCallback _callback) throws ApiException { + public okhttp3.Call updateUserItemRatingAsync(UUID itemId, UUID userId, Boolean likes, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = updateUserItemRatingValidateBeforeCall(userId, itemId, likes, _callback); + okhttp3.Call localVarCall = updateUserItemRatingValidateBeforeCall(itemId, userId, likes, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; diff --git a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/UserViewsApi.java b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/UserViewsApi.java similarity index 90% rename from bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/UserViewsApi.java rename to bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/UserViewsApi.java index 8ebc4caaaecba..331264e9872eb 100644 --- a/bundles/org.openhab.binding.jellyfin/tools/openAPI/src/api/10.8.13/src/main/java/org/openapitools/client/api/UserViewsApi.java +++ b/bundles/org.openhab.binding.jellyfin/src/main/java/org/openhab/binding/jellyfin/internal/api/generated/10.10.3/src/main/java/org/openapitools/client/api/UserViewsApi.java @@ -2,7 +2,7 @@ * Jellyfin API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 10.8.13 + * The version of the OpenAPI document: 10.10.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -28,6 +28,7 @@ import org.openapitools.client.model.BaseItemDtoQueryResult; +import org.openapitools.client.model.CollectionType; import org.openapitools.client.model.ProblemDetails; import org.openapitools.client.model.SpecialViewOptionDto; import java.util.UUID; @@ -77,7 +78,7 @@ public void setCustomBaseUrl(String customBaseUrl) { /** * Build call for getGroupingOptions - * @param userId User id. (required) + * @param userId User id. (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -108,8 +109,7 @@ public okhttp3.Call getGroupingOptionsCall(UUID userId, final ApiCallback _callb Object localVarPostBody = null; // create path and map variables - String localVarPath = "/Users/{userId}/GroupingOptions" - .replace("{" + "userId" + "}", localVarApiClient.escapeString(userId.toString())); + String localVarPath = "/UserViews/GroupingOptions"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -117,6 +117,10 @@ public okhttp3.Call getGroupingOptionsCall(UUID userId, final ApiCallback _callb Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); + if (userId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("userId", userId)); + } + final String[] localVarAccepts = { "application/json", "application/json; profile=CamelCase", @@ -140,11 +144,6 @@ public okhttp3.Call getGroupingOptionsCall(UUID userId, final ApiCallback _callb @SuppressWarnings("rawtypes") private okhttp3.Call getGroupingOptionsValidateBeforeCall(UUID userId, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'userId' is set - if (userId == null) { - throw new ApiException("Missing the required parameter 'userId' when calling getGroupingOptions(Async)"); - } - return getGroupingOptionsCall(userId, _callback); } @@ -152,7 +151,7 @@ private okhttp3.Call getGroupingOptionsValidateBeforeCall(UUID userId, final Api /** * Get user view grouping options. * - * @param userId User id. (required) + * @param userId User id. (optional) * @return List<SpecialViewOptionDto> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -173,7 +172,7 @@ public List getGroupingOptions(UUID userId) throws ApiExce /** * Get user view grouping options. * - * @param userId User id. (required) + * @param userId User id. (optional) * @return ApiResponse<List<SpecialViewOptionDto>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -195,7 +194,7 @@ public ApiResponse> getGroupingOptionsWithHttpInfo(UU /** * Get user view grouping options. (asynchronously) * - * @param userId User id. (required) + * @param userId User id. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -218,7 +217,7 @@ public okhttp3.Call getGroupingOptionsAsync(UUID userId, final ApiCallback