mirror of
https://github.com/openhab/openhab-addons.git
synced 2025-01-10 07:02:02 +01:00
feat(api): openAPI code generator - poc (wip)
Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
This commit is contained in:
Patrik Gfeller
parent
9308073c20
commit
edebc031c9
@ -9,109 +9,43 @@
|
||||
<artifactId>org.openhab.addons.reactor.bundles</artifactId>
|
||||
<version>4.3.0-SNAPSHOT</version>
|
||||
</parent>
|
||||
|
||||
<properties>
|
||||
<bnd.importpackage>
|
||||
!android.*,!com.android.*,!kotlin.internal.jdk7,!kotlin.internal.jdk8,!kotlin.reflect.*,!okhttp3.*,!okio.*
|
||||
</bnd.importpackage>
|
||||
<!-- SDK 1.4.x is no longer supported and only offers limited support for Jellyfin 10.9; it is no longer compatible with 10.10 -->
|
||||
<jellyfin.sdk>1.4.7</jellyfin.sdk>
|
||||
<openapi-generator.version>7.10.0</openapi-generator.version>
|
||||
</properties>
|
||||
|
||||
<artifactId>org.openhab.binding.jellyfin</artifactId>
|
||||
|
||||
<name>openHAB Add-ons :: Bundles :: Jellyfin Binding</name>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.jellyfin.sdk</groupId>
|
||||
<artifactId>jellyfin-core-jvm</artifactId>
|
||||
<version>${jellyfin.sdk}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.jellyfin.sdk</groupId>
|
||||
<artifactId>jellyfin-api-jvm</artifactId>
|
||||
<version>${jellyfin.sdk}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.jellyfin.sdk</groupId>
|
||||
<artifactId>jellyfin-model-jvm</artifactId>
|
||||
<version>${jellyfin.sdk}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.ktor</groupId>
|
||||
<artifactId>ktor-client-core-jvm</artifactId>
|
||||
<version>1.6.8</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.ktor</groupId>
|
||||
<artifactId>ktor-client-cio-jvm</artifactId>
|
||||
<version>1.6.8</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.ktor</groupId>
|
||||
<artifactId>ktor-http-jvm</artifactId>
|
||||
<version>1.6.8</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.ktor</groupId>
|
||||
<artifactId>ktor-http-cio-jvm</artifactId>
|
||||
<version>1.6.8</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.ktor</groupId>
|
||||
<artifactId>ktor-network-jvm</artifactId>
|
||||
<version>1.6.8</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.ktor</groupId>
|
||||
<artifactId>ktor-utils-jvm</artifactId>
|
||||
<version>1.6.8</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.ktor</groupId>
|
||||
<artifactId>ktor-io-jvm</artifactId>
|
||||
<version>1.6.8</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.ktor</groupId>
|
||||
<artifactId>ktor-network-tls-jvm</artifactId>
|
||||
<version>1.6.8</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.jetbrains.kotlin</groupId>
|
||||
<artifactId>kotlin-stdlib</artifactId>
|
||||
<version>${kotlin.version}</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.jetbrains.kotlinx</groupId>
|
||||
<artifactId>kotlinx-coroutines-core-jvm</artifactId>
|
||||
<version>1.8.0</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.jetbrains.kotlinx</groupId>
|
||||
<artifactId>kotlinx-serialization-core-jvm</artifactId>
|
||||
<version>1.6.3</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.jetbrains.kotlinx</groupId>
|
||||
<artifactId>kotlinx-serialization-json-jvm</artifactId>
|
||||
<version>1.6.3</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.github.microutils</groupId>
|
||||
<artifactId>kotlin-logging-jvm</artifactId>
|
||||
<version>3.0.5</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<!--
|
||||
***
|
||||
* 🐛 [\#18596 - [BUG] [JAVA] ClassCastException...](https://github.com/OpenAPITools/openapi-generator/issues/18596)
|
||||
*
|
||||
* ➡️ Integration into maven would depend on solving this issue first.
|
||||
***
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.openapitools</groupId>
|
||||
<artifactId>openapi-generator-maven-plugin</artifactId>
|
||||
<version>${openapi-generator.version}</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<goals>
|
||||
<goal>generate</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<inputSpec>${project.basedir}/src/main/resources/jellyfin-openapi-10.10.3.yaml</inputSpec>
|
||||
<generatorName>java</generatorName>
|
||||
<configOptions>
|
||||
<sourceFolder>src/gen/java/main</sourceFolder>
|
||||
</configOptions>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
-->
|
||||
</project>
|
||||
|
||||
1
bundles/org.openhab.binding.jellyfin/tools/openAPI/.gitignore
vendored
Normal file
1
bundles/org.openhab.binding.jellyfin/tools/openAPI/.gitignore
vendored
Normal file
@ -0,0 +1 @@
|
||||
**/*/test/*
|
||||
29
bundles/org.openhab.binding.jellyfin/tools/openAPI/generate.sh
Executable file
29
bundles/org.openhab.binding.jellyfin/tools/openAPI/generate.sh
Executable file
@ -0,0 +1,29 @@
|
||||
#!/usr/bin/bash
|
||||
|
||||
# TODO: Use repository and tag/version to get API definition
|
||||
SERVER=https://repo.jellyfin.org/releases/openapi/jellyfin-openapi-stable.json
|
||||
# SERVER=http://nuc.ehrendingen:8096/api-docs/openapi.json
|
||||
|
||||
VERSION=$(curl -sL ${SERVER} | jq -r .info.version)
|
||||
|
||||
echo "ℹ️ - Using Jellyfin API: ${VERSION}"
|
||||
|
||||
# TODO: create input subfolder for .json/.yaml
|
||||
FILENAME="./jellyfin-openapi-${VERSION}"
|
||||
|
||||
if [ ! -e "${FILENAME}.json" ]; then
|
||||
echo "⏬ - Downloading OPENAPI definition for Version ${VERSION}..."
|
||||
wget \
|
||||
--no-verbose \
|
||||
--output-document=${FILENAME}.json \
|
||||
${SERVER}
|
||||
fi
|
||||
|
||||
# TODO: Replace Server URL in .json or .yaml with a generic one ...
|
||||
# TODO: Check if .yaml exists
|
||||
|
||||
# Will not work if VS Code is installed as Ubuntu SNAP packet (no permission to stdout)
|
||||
yq -oy ${FILENAME}.json > "./${FILENAME}.yaml"
|
||||
|
||||
openapi-generator-cli generate -g java --global-property models,apis --input-spec ${FILENAME}.yaml -o src/api/${VERSION}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,7 @@
|
||||
{
|
||||
"$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
|
||||
"spaces": 2,
|
||||
"generator-cli": {
|
||||
"version": "7.10.0"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,18 @@
|
||||
|
||||
|
||||
# AccessSchedule
|
||||
|
||||
An entity representing a user's access schedule.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**id** | **Integer** | Gets the id of this instance. | [optional] [readonly] |
|
||||
|**userId** | **UUID** | Gets the id of the associated user. | [optional] |
|
||||
|**dayOfWeek** | **DynamicDayOfWeek** | Gets or sets the day of week. | [optional] |
|
||||
|**startHour** | **Double** | Gets or sets the start hour. | [optional] |
|
||||
|**endHour** | **Double** | Gets or sets the end hour. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,84 @@
|
||||
# ActivityLogApi
|
||||
|
||||
All URIs are relative to *http://nuc.ehrendingen:8096*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
|------------- | ------------- | -------------|
|
||||
| [**getLogEntries**](ActivityLogApi.md#getLogEntries) | **GET** /System/ActivityLog/Entries | Gets activity log entries. |
|
||||
|
||||
|
||||
<a id="getLogEntries"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
@ -0,0 +1,23 @@
|
||||
|
||||
|
||||
# ActivityLogEntry
|
||||
|
||||
An activity log entry.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**id** | **Long** | Gets or sets the identifier. | [optional] |
|
||||
|**name** | **String** | Gets or sets the name. | [optional] |
|
||||
|**overview** | **String** | Gets or sets the overview. | [optional] |
|
||||
|**shortOverview** | **String** | Gets or sets the short overview. | [optional] |
|
||||
|**type** | **String** | Gets or sets the type. | [optional] |
|
||||
|**itemId** | **String** | Gets or sets the item identifier. | [optional] |
|
||||
|**date** | **OffsetDateTime** | Gets or sets the date. | [optional] |
|
||||
|**userId** | **UUID** | Gets or sets the user identifier. | [optional] |
|
||||
|**userPrimaryImageTag** | **String** | Gets or sets the user primary image tag. | [optional] |
|
||||
|**severity** | **LogLevel** | Gets or sets the log severity. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,15 @@
|
||||
|
||||
|
||||
# ActivityLogEntryQueryResult
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**items** | [**List<ActivityLogEntry>**](ActivityLogEntry.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] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,14 @@
|
||||
|
||||
|
||||
# AddVirtualFolderDto
|
||||
|
||||
Add virtual folder dto.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**libraryOptions** | [**LibraryOptions**](LibraryOptions.md) | Gets or sets library options. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,17 @@
|
||||
|
||||
|
||||
# AdminNotificationDto
|
||||
|
||||
The admin notification dto.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | Gets or sets the notification name. | [optional] |
|
||||
|**description** | **String** | Gets or sets the notification description. | [optional] |
|
||||
|**notificationLevel** | **NotificationLevel** | Gets or sets the notification level. | [optional] |
|
||||
|**url** | **String** | Gets or sets the notification url. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,26 @@
|
||||
|
||||
|
||||
# AlbumInfo
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | Gets or sets the name. | [optional] |
|
||||
|**originalTitle** | **String** | Gets or sets the original title. | [optional] |
|
||||
|**path** | **String** | Gets or sets the path. | [optional] |
|
||||
|**metadataLanguage** | **String** | Gets or sets the metadata language. | [optional] |
|
||||
|**metadataCountryCode** | **String** | Gets or sets the metadata country code. | [optional] |
|
||||
|**providerIds** | **Map<String, String>** | Gets or sets the provider ids. | [optional] |
|
||||
|**year** | **Integer** | Gets or sets the year. | [optional] |
|
||||
|**indexNumber** | **Integer** | | [optional] |
|
||||
|**parentIndexNumber** | **Integer** | | [optional] |
|
||||
|**premiereDate** | **OffsetDateTime** | | [optional] |
|
||||
|**isAutomated** | **Boolean** | | [optional] |
|
||||
|**albumArtists** | **List<String>** | Gets or sets the album artist. | [optional] |
|
||||
|**artistProviderIds** | **Map<String, String>** | Gets or sets the artist provider ids. | [optional] |
|
||||
|**songInfos** | [**List<SongInfo>**](SongInfo.md) | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,16 @@
|
||||
|
||||
|
||||
# AlbumInfoRemoteSearchQuery
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**searchInfo** | [**AlbumInfo**](AlbumInfo.md) | | [optional] |
|
||||
|**itemId** | **UUID** | | [optional] |
|
||||
|**searchProviderName** | **String** | Gets or sets the provider name to search within if set. | [optional] |
|
||||
|**includeDisabledProviders** | **Boolean** | Gets or sets a value indicating whether disabled providers should be included. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,15 @@
|
||||
|
||||
|
||||
# AllThemeMediaResult
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**themeVideosResult** | [**ThemeMediaResult**](ThemeMediaResult.md) | Class ThemeMediaResult. | [optional] |
|
||||
|**themeSongsResult** | [**ThemeMediaResult**](ThemeMediaResult.md) | Class ThemeMediaResult. | [optional] |
|
||||
|**soundtrackSongsResult** | [**ThemeMediaResult**](ThemeMediaResult.md) | Class ThemeMediaResult. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,212 @@
|
||||
# ApiKeyApi
|
||||
|
||||
All URIs are relative to *http://nuc.ehrendingen:8096*
|
||||
|
||||
| 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. |
|
||||
|
||||
|
||||
<a id="createKey"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
<a id="getKeys"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
<a id="revokeKey"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
@ -0,0 +1,21 @@
|
||||
|
||||
|
||||
# Architecture
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `X86` (value: `"X86"`)
|
||||
|
||||
* `X64` (value: `"X64"`)
|
||||
|
||||
* `ARM` (value: `"Arm"`)
|
||||
|
||||
* `ARM64` (value: `"Arm64"`)
|
||||
|
||||
* `WASM` (value: `"Wasm"`)
|
||||
|
||||
* `S390X` (value: `"S390x"`)
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,24 @@
|
||||
|
||||
|
||||
# ArtistInfo
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | Gets or sets the name. | [optional] |
|
||||
|**originalTitle** | **String** | Gets or sets the original title. | [optional] |
|
||||
|**path** | **String** | Gets or sets the path. | [optional] |
|
||||
|**metadataLanguage** | **String** | Gets or sets the metadata language. | [optional] |
|
||||
|**metadataCountryCode** | **String** | Gets or sets the metadata country code. | [optional] |
|
||||
|**providerIds** | **Map<String, String>** | Gets or sets the provider ids. | [optional] |
|
||||
|**year** | **Integer** | Gets or sets the year. | [optional] |
|
||||
|**indexNumber** | **Integer** | | [optional] |
|
||||
|**parentIndexNumber** | **Integer** | | [optional] |
|
||||
|**premiereDate** | **OffsetDateTime** | | [optional] |
|
||||
|**isAutomated** | **Boolean** | | [optional] |
|
||||
|**songInfos** | [**List<SongInfo>**](SongInfo.md) | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,16 @@
|
||||
|
||||
|
||||
# ArtistInfoRemoteSearchQuery
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**searchInfo** | [**ArtistInfo**](ArtistInfo.md) | | [optional] |
|
||||
|**itemId** | **UUID** | | [optional] |
|
||||
|**searchProviderName** | **String** | Gets or sets the provider name to search within if set. | [optional] |
|
||||
|**includeDisabledProviders** | **Boolean** | Gets or sets a value indicating whether disabled providers should be included. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,344 @@
|
||||
# ArtistsApi
|
||||
|
||||
All URIs are relative to *http://nuc.ehrendingen:8096*
|
||||
|
||||
| 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. |
|
||||
|
||||
|
||||
<a id="getAlbumArtists"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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<ItemFields> fields = Arrays.asList(); // List<ItemFields> | Optional. Specify additional fields of information to return in the output.
|
||||
List<BaseItemKind> excludeItemTypes = Arrays.asList(); // List<BaseItemKind> | Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
|
||||
List<BaseItemKind> includeItemTypes = Arrays.asList(); // List<BaseItemKind> | Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
||||
List<ItemFilter> filters = Arrays.asList(); // List<ItemFilter> | Optional. Specify additional filters to apply.
|
||||
Boolean isFavorite = true; // Boolean | Optional filter by items that are marked as favorite, or not.
|
||||
List<String> mediaTypes = Arrays.asList(); // List<String> | Optional filter by MediaType. Allows multiple, comma delimited.
|
||||
List<String> genres = Arrays.asList(); // List<String> | Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
||||
List<UUID> genreIds = Arrays.asList(); // List<UUID> | Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
||||
List<String> officialRatings = Arrays.asList(); // List<String> | Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
||||
List<String> tags = Arrays.asList(); // List<String> | Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
||||
List<Integer> years = Arrays.asList(); // List<Integer> | 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<ImageType> enableImageTypes = Arrays.asList(); // List<ImageType> | 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<UUID> personIds = Arrays.asList(); // List<UUID> | Optional. If specified, results will be filtered to include only those containing the specified person ids.
|
||||
List<String> personTypes = Arrays.asList(); // List<String> | 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<String> studios = Arrays.asList(); // List<String> | Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
||||
List<UUID> studioIds = Arrays.asList(); // List<UUID> | 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<String> sortBy = Arrays.asList(); // List<String> | Optional. Specify one or more sort orders, comma delimited.
|
||||
List<SortOrder> sortOrder = Arrays.asList(); // List<SortOrder> | 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<String>**](String.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<String>**](String.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 | - |
|
||||
|
||||
<a id="getArtistByName"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
<a id="getArtists"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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<ItemFields> fields = Arrays.asList(); // List<ItemFields> | Optional. Specify additional fields of information to return in the output.
|
||||
List<BaseItemKind> excludeItemTypes = Arrays.asList(); // List<BaseItemKind> | Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
|
||||
List<BaseItemKind> includeItemTypes = Arrays.asList(); // List<BaseItemKind> | Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
||||
List<ItemFilter> filters = Arrays.asList(); // List<ItemFilter> | Optional. Specify additional filters to apply.
|
||||
Boolean isFavorite = true; // Boolean | Optional filter by items that are marked as favorite, or not.
|
||||
List<String> mediaTypes = Arrays.asList(); // List<String> | Optional filter by MediaType. Allows multiple, comma delimited.
|
||||
List<String> genres = Arrays.asList(); // List<String> | Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
||||
List<UUID> genreIds = Arrays.asList(); // List<UUID> | Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
||||
List<String> officialRatings = Arrays.asList(); // List<String> | Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
||||
List<String> tags = Arrays.asList(); // List<String> | Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
||||
List<Integer> years = Arrays.asList(); // List<Integer> | 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<ImageType> enableImageTypes = Arrays.asList(); // List<ImageType> | 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<UUID> personIds = Arrays.asList(); // List<UUID> | Optional. If specified, results will be filtered to include only those containing the specified person ids.
|
||||
List<String> personTypes = Arrays.asList(); // List<String> | 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<String> studios = Arrays.asList(); // List<String> | Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
||||
List<UUID> studioIds = Arrays.asList(); // List<UUID> | 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<String> sortBy = Arrays.asList(); // List<String> | Optional. Specify one or more sort orders, comma delimited.
|
||||
List<SortOrder> sortOrder = Arrays.asList(); // List<SortOrder> | 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<String>**](String.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<String>**](String.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 | - |
|
||||
|
||||
@ -0,0 +1,636 @@
|
||||
# AudioApi
|
||||
|
||||
All URIs are relative to *http://nuc.ehrendingen:8096*
|
||||
|
||||
| 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. |
|
||||
|
||||
|
||||
<a id="getAudioStream"></a>
|
||||
# **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)
|
||||
|
||||
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://nuc.ehrendingen:8096");
|
||||
|
||||
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 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.
|
||||
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. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv.
|
||||
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<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
|
||||
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);
|
||||
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 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] |
|
||||
| **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**](.md)| 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. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. | [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**](.md)| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
|
||||
| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] |
|
||||
|
||||
### 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. | - |
|
||||
|
||||
<a id="getAudioStreamByContainer"></a>
|
||||
# **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)
|
||||
|
||||
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://nuc.ehrendingen:8096");
|
||||
|
||||
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 lenght.
|
||||
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 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.
|
||||
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. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv.
|
||||
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<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
|
||||
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);
|
||||
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 lenght. | [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 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] |
|
||||
| **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**](.md)| 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. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. | [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**](.md)| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
|
||||
| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] |
|
||||
|
||||
### 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. | - |
|
||||
|
||||
<a id="headAudioStream"></a>
|
||||
# **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)
|
||||
|
||||
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://nuc.ehrendingen:8096");
|
||||
|
||||
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 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.
|
||||
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. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv.
|
||||
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<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
|
||||
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);
|
||||
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 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] |
|
||||
| **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**](.md)| 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. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. | [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**](.md)| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
|
||||
| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] |
|
||||
|
||||
### 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. | - |
|
||||
|
||||
<a id="headAudioStreamByContainer"></a>
|
||||
# **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)
|
||||
|
||||
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://nuc.ehrendingen:8096");
|
||||
|
||||
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 lenght.
|
||||
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 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.
|
||||
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. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv.
|
||||
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<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
|
||||
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);
|
||||
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 lenght. | [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 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] |
|
||||
| **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**](.md)| 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. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. | [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**](.md)| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
|
||||
| **streamOptions** | [**Map<String, String>**](String.md)| Optional. The streaming options. | [optional] |
|
||||
|
||||
### 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. | - |
|
||||
|
||||
@ -0,0 +1,16 @@
|
||||
|
||||
|
||||
# AuthenticateUserByName
|
||||
|
||||
The authenticate user by name request body.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**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] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,24 @@
|
||||
|
||||
|
||||
# AuthenticationInfo
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**id** | **Long** | Gets or sets the identifier. | [optional] |
|
||||
|**accessToken** | **String** | Gets or sets the access token. | [optional] |
|
||||
|**deviceId** | **String** | Gets or sets the device identifier. | [optional] |
|
||||
|**appName** | **String** | Gets or sets the name of the application. | [optional] |
|
||||
|**appVersion** | **String** | Gets or sets the application version. | [optional] |
|
||||
|**deviceName** | **String** | Gets or sets the name of the device. | [optional] |
|
||||
|**userId** | **UUID** | Gets or sets the user identifier. | [optional] |
|
||||
|**isActive** | **Boolean** | Gets or sets a value indicating whether this instance is active. | [optional] |
|
||||
|**dateCreated** | **OffsetDateTime** | Gets or sets the date created. | [optional] |
|
||||
|**dateRevoked** | **OffsetDateTime** | Gets or sets the date revoked. | [optional] |
|
||||
|**dateLastActivity** | **OffsetDateTime** | | [optional] |
|
||||
|**userName** | **String** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,15 @@
|
||||
|
||||
|
||||
# AuthenticationInfoQueryResult
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**items** | [**List<AuthenticationInfo>**](AuthenticationInfo.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] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,16 @@
|
||||
|
||||
|
||||
# AuthenticationResult
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**user** | [**UserDto**](UserDto.md) | Class UserDto. | [optional] |
|
||||
|**sessionInfo** | [**SessionInfo**](SessionInfo.md) | Class SessionInfo. | [optional] |
|
||||
|**accessToken** | **String** | | [optional] |
|
||||
|**serverId** | **String** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,24 @@
|
||||
|
||||
|
||||
# BaseItem
|
||||
|
||||
Class BaseItem.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**size** | **Long** | | [optional] |
|
||||
|**container** | **String** | | [optional] |
|
||||
|**isHD** | **Boolean** | | [optional] [readonly] |
|
||||
|**isShortcut** | **Boolean** | | [optional] |
|
||||
|**shortcutPath** | **String** | | [optional] |
|
||||
|**width** | **Integer** | | [optional] |
|
||||
|**height** | **Integer** | | [optional] |
|
||||
|**extraIds** | **List<UUID>** | | [optional] |
|
||||
|**dateLastSaved** | **OffsetDateTime** | | [optional] |
|
||||
|**remoteTrailers** | [**List<MediaUrl>**](MediaUrl.md) | Gets or sets the remote trailers. | [optional] |
|
||||
|**supportsExternalTransfer** | **Boolean** | | [optional] [readonly] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,164 @@
|
||||
|
||||
|
||||
# BaseItemDto
|
||||
|
||||
This is strictly used as a data transfer object from the api layer. This holds information about a BaseItem in a format that is convenient for the client.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | Gets or sets the name. | [optional] |
|
||||
|**originalTitle** | **String** | | [optional] |
|
||||
|**serverId** | **String** | Gets or sets the server identifier. | [optional] |
|
||||
|**id** | **UUID** | Gets or sets the id. | [optional] |
|
||||
|**etag** | **String** | Gets or sets the etag. | [optional] |
|
||||
|**sourceType** | **String** | Gets or sets the type of the source. | [optional] |
|
||||
|**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] |
|
||||
|**airsBeforeSeasonNumber** | **Integer** | | [optional] |
|
||||
|**airsAfterSeasonNumber** | **Integer** | | [optional] |
|
||||
|**airsBeforeEpisodeNumber** | **Integer** | | [optional] |
|
||||
|**canDelete** | **Boolean** | | [optional] |
|
||||
|**canDownload** | **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] |
|
||||
|**video3DFormat** | **Video3DFormat** | Gets or sets the video3 D format. | [optional] |
|
||||
|**premiereDate** | **OffsetDateTime** | Gets or sets the premiere date. | [optional] |
|
||||
|**externalUrls** | [**List<ExternalUrl>**](ExternalUrl.md) | Gets or sets the external urls. | [optional] |
|
||||
|**mediaSources** | [**List<MediaSourceInfo>**](MediaSourceInfo.md) | Gets or sets the media versions. | [optional] |
|
||||
|**criticRating** | **Float** | Gets or sets the critic rating. | [optional] |
|
||||
|**productionLocations** | **List<String>** | | [optional] |
|
||||
|**path** | **String** | Gets or sets the path. | [optional] |
|
||||
|**enableMediaSourceDisplay** | **Boolean** | | [optional] |
|
||||
|**officialRating** | **String** | Gets or sets the official rating. | [optional] |
|
||||
|**customRating** | **String** | Gets or sets the custom rating. | [optional] |
|
||||
|**channelId** | **UUID** | Gets or sets the channel identifier. | [optional] |
|
||||
|**channelName** | **String** | | [optional] |
|
||||
|**overview** | **String** | Gets or sets the overview. | [optional] |
|
||||
|**taglines** | **List<String>** | Gets or sets the taglines. | [optional] |
|
||||
|**genres** | **List<String>** | Gets or sets the genres. | [optional] |
|
||||
|**communityRating** | **Float** | Gets or sets the community rating. | [optional] |
|
||||
|**cumulativeRunTimeTicks** | **Long** | Gets or sets the cumulative run time ticks. | [optional] |
|
||||
|**runTimeTicks** | **Long** | Gets or sets the run time ticks. | [optional] |
|
||||
|**playAccess** | **PlayAccess** | Gets or sets the play access. | [optional] |
|
||||
|**aspectRatio** | **String** | Gets or sets the aspect ratio. | [optional] |
|
||||
|**productionYear** | **Integer** | Gets or sets the production year. | [optional] |
|
||||
|**isPlaceHolder** | **Boolean** | Gets or sets a value indicating whether this instance is place holder. | [optional] |
|
||||
|**number** | **String** | Gets or sets the number. | [optional] |
|
||||
|**channelNumber** | **String** | | [optional] |
|
||||
|**indexNumber** | **Integer** | Gets or sets the index number. | [optional] |
|
||||
|**indexNumberEnd** | **Integer** | Gets or sets the index number end. | [optional] |
|
||||
|**parentIndexNumber** | **Integer** | Gets or sets the parent index number. | [optional] |
|
||||
|**remoteTrailers** | [**List<MediaUrl>**](MediaUrl.md) | Gets or sets the trailer urls. | [optional] |
|
||||
|**providerIds** | **Map<String, String>** | Gets or sets the provider ids. | [optional] |
|
||||
|**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] |
|
||||
|**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] |
|
||||
|**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] |
|
||||
|**recursiveItemCount** | **Integer** | Gets or sets the recursive item count. | [optional] |
|
||||
|**childCount** | **Integer** | Gets or sets the child count. | [optional] |
|
||||
|**seriesName** | **String** | Gets or sets the name of the series. | [optional] |
|
||||
|**seriesId** | **UUID** | Gets or sets the series id. | [optional] |
|
||||
|**seasonId** | **UUID** | Gets or sets the season identifier. | [optional] |
|
||||
|**specialFeatureCount** | **Integer** | Gets or sets the special feature count. | [optional] |
|
||||
|**displayPreferencesId** | **String** | Gets or sets the display preferences id. | [optional] |
|
||||
|**status** | **String** | Gets or sets the status. | [optional] |
|
||||
|**airTime** | **String** | Gets or sets the air time. | [optional] |
|
||||
|**airDays** | **List<DayOfWeek>** | Gets or sets the air days. | [optional] |
|
||||
|**tags** | **List<String>** | Gets or sets the tags. | [optional] |
|
||||
|**primaryImageAspectRatio** | **Double** | Gets or sets the primary image aspect ratio, after image enhancements. | [optional] |
|
||||
|**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] |
|
||||
|**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] |
|
||||
|**seriesPrimaryImageTag** | **String** | Gets or sets the series primary image tag. | [optional] |
|
||||
|**albumArtist** | **String** | Gets or sets the album artist. | [optional] |
|
||||
|**albumArtists** | [**List<NameGuidPair>**](NameGuidPair.md) | Gets or sets the album artists. | [optional] |
|
||||
|**seasonName** | **String** | Gets or sets the name of the season. | [optional] |
|
||||
|**mediaStreams** | [**List<MediaStream>**](MediaStream.md) | Gets or sets the media streams. | [optional] |
|
||||
|**videoType** | **VideoType** | Gets or sets the type of the video. | [optional] |
|
||||
|**partCount** | **Integer** | Gets or sets the part count. | [optional] |
|
||||
|**mediaSourceCount** | **Integer** | | [optional] |
|
||||
|**imageTags** | **Map<String, String>** | Gets or sets the image tags. | [optional] |
|
||||
|**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] |
|
||||
|**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] |
|
||||
|**seriesStudio** | **String** | Gets or sets the series studio. | [optional] |
|
||||
|**parentThumbItemId** | **UUID** | Gets or sets the parent thumb item id. | [optional] |
|
||||
|**parentThumbImageTag** | **String** | Gets or sets the parent thumb image tag. | [optional] |
|
||||
|**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] |
|
||||
|**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] |
|
||||
|**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] |
|
||||
|**movieCount** | **Integer** | Gets or sets the movie count. | [optional] |
|
||||
|**seriesCount** | **Integer** | Gets or sets the series count. | [optional] |
|
||||
|**programCount** | **Integer** | | [optional] |
|
||||
|**episodeCount** | **Integer** | Gets or sets the episode count. | [optional] |
|
||||
|**songCount** | **Integer** | Gets or sets the song count. | [optional] |
|
||||
|**albumCount** | **Integer** | Gets or sets the album count. | [optional] |
|
||||
|**artistCount** | **Integer** | | [optional] |
|
||||
|**musicVideoCount** | **Integer** | Gets or sets the music video count. | [optional] |
|
||||
|**lockData** | **Boolean** | Gets or sets a value indicating whether [enable internet providers]. | [optional] |
|
||||
|**width** | **Integer** | | [optional] |
|
||||
|**height** | **Integer** | | [optional] |
|
||||
|**cameraMake** | **String** | | [optional] |
|
||||
|**cameraModel** | **String** | | [optional] |
|
||||
|**software** | **String** | | [optional] |
|
||||
|**exposureTime** | **Double** | | [optional] |
|
||||
|**focalLength** | **Double** | | [optional] |
|
||||
|**imageOrientation** | **ImageOrientation** | | [optional] |
|
||||
|**aperture** | **Double** | | [optional] |
|
||||
|**shutterSpeed** | **Double** | | [optional] |
|
||||
|**latitude** | **Double** | | [optional] |
|
||||
|**longitude** | **Double** | | [optional] |
|
||||
|**altitude** | **Double** | | [optional] |
|
||||
|**isoSpeedRating** | **Integer** | | [optional] |
|
||||
|**seriesTimerId** | **String** | Gets or sets the series timer identifier. | [optional] |
|
||||
|**programId** | **String** | Gets or sets the program identifier. | [optional] |
|
||||
|**channelPrimaryImageTag** | **String** | Gets or sets the channel primary image tag. | [optional] |
|
||||
|**startDate** | **OffsetDateTime** | Gets or sets the start date of the recording, in UTC. | [optional] |
|
||||
|**completionPercentage** | **Double** | Gets or sets the completion percentage. | [optional] |
|
||||
|**isRepeat** | **Boolean** | Gets or sets a value indicating whether this instance is repeat. | [optional] |
|
||||
|**episodeTitle** | **String** | Gets or sets the episode title. | [optional] |
|
||||
|**channelType** | **ChannelType** | Gets or sets the type of the channel. | [optional] |
|
||||
|**audio** | **ProgramAudio** | Gets or sets the audio. | [optional] |
|
||||
|**isMovie** | **Boolean** | Gets or sets a value indicating whether this instance is movie. | [optional] |
|
||||
|**isSports** | **Boolean** | Gets or sets a value indicating whether this instance is sports. | [optional] |
|
||||
|**isSeries** | **Boolean** | Gets or sets a value indicating whether this instance is series. | [optional] |
|
||||
|**isLive** | **Boolean** | Gets or sets a value indicating whether this instance is live. | [optional] |
|
||||
|**isNews** | **Boolean** | Gets or sets a value indicating whether this instance is news. | [optional] |
|
||||
|**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] |
|
||||
|**currentProgram** | [**BaseItemDto**](BaseItemDto.md) | Gets or sets the current program. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,26 @@
|
||||
|
||||
|
||||
# BaseItemDtoImageBlurHashes
|
||||
|
||||
Gets or sets the blurhashes for the image tags. Maps image type to dictionary mapping image tag to blurhash value.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**primary** | **Map<String, String>** | | [optional] |
|
||||
|**art** | **Map<String, String>** | | [optional] |
|
||||
|**backdrop** | **Map<String, String>** | | [optional] |
|
||||
|**banner** | **Map<String, String>** | | [optional] |
|
||||
|**logo** | **Map<String, String>** | | [optional] |
|
||||
|**thumb** | **Map<String, String>** | | [optional] |
|
||||
|**disc** | **Map<String, String>** | | [optional] |
|
||||
|**box** | **Map<String, String>** | | [optional] |
|
||||
|**screenshot** | **Map<String, String>** | | [optional] |
|
||||
|**menu** | **Map<String, String>** | | [optional] |
|
||||
|**chapter** | **Map<String, String>** | | [optional] |
|
||||
|**boxRear** | **Map<String, String>** | | [optional] |
|
||||
|**profile** | **Map<String, String>** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,15 @@
|
||||
|
||||
|
||||
# BaseItemDtoQueryResult
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**items** | [**List<BaseItemDto>**](BaseItemDto.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] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,83 @@
|
||||
|
||||
|
||||
# BaseItemKind
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `AGGREGATE_FOLDER` (value: `"AggregateFolder"`)
|
||||
|
||||
* `AUDIO` (value: `"Audio"`)
|
||||
|
||||
* `AUDIO_BOOK` (value: `"AudioBook"`)
|
||||
|
||||
* `BASE_PLUGIN_FOLDER` (value: `"BasePluginFolder"`)
|
||||
|
||||
* `BOOK` (value: `"Book"`)
|
||||
|
||||
* `BOX_SET` (value: `"BoxSet"`)
|
||||
|
||||
* `CHANNEL` (value: `"Channel"`)
|
||||
|
||||
* `CHANNEL_FOLDER_ITEM` (value: `"ChannelFolderItem"`)
|
||||
|
||||
* `COLLECTION_FOLDER` (value: `"CollectionFolder"`)
|
||||
|
||||
* `EPISODE` (value: `"Episode"`)
|
||||
|
||||
* `FOLDER` (value: `"Folder"`)
|
||||
|
||||
* `GENRE` (value: `"Genre"`)
|
||||
|
||||
* `MANUAL_PLAYLISTS_FOLDER` (value: `"ManualPlaylistsFolder"`)
|
||||
|
||||
* `MOVIE` (value: `"Movie"`)
|
||||
|
||||
* `LIVE_TV_CHANNEL` (value: `"LiveTvChannel"`)
|
||||
|
||||
* `LIVE_TV_PROGRAM` (value: `"LiveTvProgram"`)
|
||||
|
||||
* `MUSIC_ALBUM` (value: `"MusicAlbum"`)
|
||||
|
||||
* `MUSIC_ARTIST` (value: `"MusicArtist"`)
|
||||
|
||||
* `MUSIC_GENRE` (value: `"MusicGenre"`)
|
||||
|
||||
* `MUSIC_VIDEO` (value: `"MusicVideo"`)
|
||||
|
||||
* `PERSON` (value: `"Person"`)
|
||||
|
||||
* `PHOTO` (value: `"Photo"`)
|
||||
|
||||
* `PHOTO_ALBUM` (value: `"PhotoAlbum"`)
|
||||
|
||||
* `PLAYLIST` (value: `"Playlist"`)
|
||||
|
||||
* `PLAYLISTS_FOLDER` (value: `"PlaylistsFolder"`)
|
||||
|
||||
* `PROGRAM` (value: `"Program"`)
|
||||
|
||||
* `RECORDING` (value: `"Recording"`)
|
||||
|
||||
* `SEASON` (value: `"Season"`)
|
||||
|
||||
* `SERIES` (value: `"Series"`)
|
||||
|
||||
* `STUDIO` (value: `"Studio"`)
|
||||
|
||||
* `TRAILER` (value: `"Trailer"`)
|
||||
|
||||
* `TV_CHANNEL` (value: `"TvChannel"`)
|
||||
|
||||
* `TV_PROGRAM` (value: `"TvProgram"`)
|
||||
|
||||
* `USER_ROOT_FOLDER` (value: `"UserRootFolder"`)
|
||||
|
||||
* `USER_VIEW` (value: `"UserView"`)
|
||||
|
||||
* `VIDEO` (value: `"Video"`)
|
||||
|
||||
* `YEAR` (value: `"Year"`)
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,19 @@
|
||||
|
||||
|
||||
# BaseItemPerson
|
||||
|
||||
This is used by the api to get information about a Person within a BaseItem.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**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] |
|
||||
|**primaryImageTag** | **String** | Gets or sets the primary image tag. | [optional] |
|
||||
|**imageBlurHashes** | [**BaseItemPersonImageBlurHashes**](BaseItemPersonImageBlurHashes.md) | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,26 @@
|
||||
|
||||
|
||||
# BaseItemPersonImageBlurHashes
|
||||
|
||||
Gets or sets the primary image blurhash.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**primary** | **Map<String, String>** | | [optional] |
|
||||
|**art** | **Map<String, String>** | | [optional] |
|
||||
|**backdrop** | **Map<String, String>** | | [optional] |
|
||||
|**banner** | **Map<String, String>** | | [optional] |
|
||||
|**logo** | **Map<String, String>** | | [optional] |
|
||||
|**thumb** | **Map<String, String>** | | [optional] |
|
||||
|**disc** | **Map<String, String>** | | [optional] |
|
||||
|**box** | **Map<String, String>** | | [optional] |
|
||||
|**screenshot** | **Map<String, String>** | | [optional] |
|
||||
|**menu** | **Map<String, String>** | | [optional] |
|
||||
|**chapter** | **Map<String, String>** | | [optional] |
|
||||
|**boxRear** | **Map<String, String>** | | [optional] |
|
||||
|**profile** | **Map<String, String>** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,24 @@
|
||||
|
||||
|
||||
# BookInfo
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | Gets or sets the name. | [optional] |
|
||||
|**originalTitle** | **String** | Gets or sets the original title. | [optional] |
|
||||
|**path** | **String** | Gets or sets the path. | [optional] |
|
||||
|**metadataLanguage** | **String** | Gets or sets the metadata language. | [optional] |
|
||||
|**metadataCountryCode** | **String** | Gets or sets the metadata country code. | [optional] |
|
||||
|**providerIds** | **Map<String, String>** | Gets or sets the provider ids. | [optional] |
|
||||
|**year** | **Integer** | Gets or sets the year. | [optional] |
|
||||
|**indexNumber** | **Integer** | | [optional] |
|
||||
|**parentIndexNumber** | **Integer** | | [optional] |
|
||||
|**premiereDate** | **OffsetDateTime** | | [optional] |
|
||||
|**isAutomated** | **Boolean** | | [optional] |
|
||||
|**seriesName** | **String** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,16 @@
|
||||
|
||||
|
||||
# BookInfoRemoteSearchQuery
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**searchInfo** | [**BookInfo**](BookInfo.md) | | [optional] |
|
||||
|**itemId** | **UUID** | | [optional] |
|
||||
|**searchProviderName** | **String** | Gets or sets the provider name to search within if set. | [optional] |
|
||||
|**includeDisabledProviders** | **Boolean** | Gets or sets a value indicating whether disabled providers should be included. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,23 @@
|
||||
|
||||
|
||||
# BoxSetInfo
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | Gets or sets the name. | [optional] |
|
||||
|**originalTitle** | **String** | Gets or sets the original title. | [optional] |
|
||||
|**path** | **String** | Gets or sets the path. | [optional] |
|
||||
|**metadataLanguage** | **String** | Gets or sets the metadata language. | [optional] |
|
||||
|**metadataCountryCode** | **String** | Gets or sets the metadata country code. | [optional] |
|
||||
|**providerIds** | **Map<String, String>** | Gets or sets the provider ids. | [optional] |
|
||||
|**year** | **Integer** | Gets or sets the year. | [optional] |
|
||||
|**indexNumber** | **Integer** | | [optional] |
|
||||
|**parentIndexNumber** | **Integer** | | [optional] |
|
||||
|**premiereDate** | **OffsetDateTime** | | [optional] |
|
||||
|**isAutomated** | **Boolean** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,16 @@
|
||||
|
||||
|
||||
# BoxSetInfoRemoteSearchQuery
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**searchInfo** | [**BoxSetInfo**](BoxSetInfo.md) | | [optional] |
|
||||
|**itemId** | **UUID** | | [optional] |
|
||||
|**searchProviderName** | **String** | Gets or sets the provider name to search within if set. | [optional] |
|
||||
|**includeDisabledProviders** | **Boolean** | Gets or sets a value indicating whether disabled providers should be included. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,181 @@
|
||||
# BrandingApi
|
||||
|
||||
All URIs are relative to *http://nuc.ehrendingen:8096*
|
||||
|
||||
| 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. |
|
||||
|
||||
|
||||
<a id="getBrandingCss"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
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. | - |
|
||||
|
||||
<a id="getBrandingCss2"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
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. | - |
|
||||
|
||||
<a id="getBrandingOptions"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
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. | - |
|
||||
|
||||
@ -0,0 +1,16 @@
|
||||
|
||||
|
||||
# BrandingOptions
|
||||
|
||||
The branding options.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**loginDisclaimer** | **String** | Gets or sets the login disclaimer. | [optional] |
|
||||
|**customCss** | **String** | Gets or sets the custom CSS. | [optional] |
|
||||
|**splashscreenEnabled** | **Boolean** | Gets or sets a value indicating whether to enable the splashscreen. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,17 @@
|
||||
|
||||
|
||||
# BufferRequestDto
|
||||
|
||||
Class BufferRequestDto.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**when** | **OffsetDateTime** | Gets or sets when the request has been made by the client. | [optional] |
|
||||
|**positionTicks** | **Long** | Gets or sets the position ticks. | [optional] |
|
||||
|**isPlaying** | **Boolean** | Gets or sets a value indicating whether the client playback is unpaused. | [optional] |
|
||||
|**playlistItemId** | **UUID** | Gets or sets the playlist item identifier of the playing item. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,24 @@
|
||||
|
||||
|
||||
# ChannelFeatures
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | Gets or sets the name. | [optional] |
|
||||
|**id** | **UUID** | Gets or sets the identifier. | [optional] |
|
||||
|**canSearch** | **Boolean** | Gets or sets a value indicating whether this instance can search. | [optional] |
|
||||
|**mediaTypes** | **List<ChannelMediaType>** | Gets or sets the media types. | [optional] |
|
||||
|**contentTypes** | **List<ChannelMediaContentType>** | Gets or sets the content types. | [optional] |
|
||||
|**maxPageSize** | **Integer** | Gets or sets the maximum number of records the channel allows retrieving at a time. | [optional] |
|
||||
|**autoRefreshLevels** | **Integer** | Gets or sets the automatic refresh levels. | [optional] |
|
||||
|**defaultSortFields** | **List<ChannelItemSortField>** | Gets or sets the default sort orders. | [optional] |
|
||||
|**supportsSortOrderToggle** | **Boolean** | Gets or sets a value indicating whether a sort ascending/descending toggle is supported. | [optional] |
|
||||
|**supportsLatestMedia** | **Boolean** | Gets or sets a value indicating whether [supports latest media]. | [optional] |
|
||||
|**canFilter** | **Boolean** | Gets or sets a value indicating whether this instance can filter. | [optional] |
|
||||
|**supportsContentDownloading** | **Boolean** | Gets or sets a value indicating whether [supports content downloading]. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,23 @@
|
||||
|
||||
|
||||
# ChannelItemSortField
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `NAME` (value: `"Name"`)
|
||||
|
||||
* `COMMUNITY_RATING` (value: `"CommunityRating"`)
|
||||
|
||||
* `PREMIERE_DATE` (value: `"PremiereDate"`)
|
||||
|
||||
* `DATE_CREATED` (value: `"DateCreated"`)
|
||||
|
||||
* `RUNTIME` (value: `"Runtime"`)
|
||||
|
||||
* `PLAY_COUNT` (value: `"PlayCount"`)
|
||||
|
||||
* `COMMUNITY_PLAY_COUNT` (value: `"CommunityPlayCount"`)
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,17 @@
|
||||
|
||||
|
||||
# ChannelMappingOptionsDto
|
||||
|
||||
Channel mapping options dto.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**tunerChannels** | [**List<TunerChannelMapping>**](TunerChannelMapping.md) | Gets or sets list of tuner channels. | [optional] |
|
||||
|**providerChannels** | [**List<NameIdPair>**](NameIdPair.md) | Gets or sets list of provider channels. | [optional] |
|
||||
|**mappings** | [**List<NameValuePair>**](NameValuePair.md) | Gets or sets list of mappings. | [optional] |
|
||||
|**providerName** | **String** | Gets or sets provider name. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,25 @@
|
||||
|
||||
|
||||
# ChannelMediaContentType
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `CLIP` (value: `"Clip"`)
|
||||
|
||||
* `PODCAST` (value: `"Podcast"`)
|
||||
|
||||
* `TRAILER` (value: `"Trailer"`)
|
||||
|
||||
* `MOVIE` (value: `"Movie"`)
|
||||
|
||||
* `EPISODE` (value: `"Episode"`)
|
||||
|
||||
* `SONG` (value: `"Song"`)
|
||||
|
||||
* `MOVIE_EXTRA` (value: `"MovieExtra"`)
|
||||
|
||||
* `TV_EXTRA` (value: `"TvExtra"`)
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,15 @@
|
||||
|
||||
|
||||
# ChannelMediaType
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `AUDIO` (value: `"Audio"`)
|
||||
|
||||
* `VIDEO` (value: `"Video"`)
|
||||
|
||||
* `PHOTO` (value: `"Photo"`)
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,13 @@
|
||||
|
||||
|
||||
# ChannelType
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `TV` (value: `"TV"`)
|
||||
|
||||
* `RADIO` (value: `"Radio"`)
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,390 @@
|
||||
# ChannelsApi
|
||||
|
||||
All URIs are relative to *http://nuc.ehrendingen:8096*
|
||||
|
||||
| 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. |
|
||||
|
||||
|
||||
<a id="getAllChannelFeatures"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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<ChannelFeatures> 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 | - |
|
||||
|
||||
<a id="getChannelFeatures"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
<a id="getChannelItems"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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> sortOrder = Arrays.asList(); // List<SortOrder> | Optional. Sort Order - Ascending,Descending.
|
||||
List<ItemFilter> filters = Arrays.asList(); // List<ItemFilter> | Optional. Specify additional filters to apply.
|
||||
List<String> sortBy = Arrays.asList(); // List<String> | 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<ItemFields> fields = Arrays.asList(); // List<ItemFields> | 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<String>**](String.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 | - |
|
||||
|
||||
<a id="getChannels"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
<a id="getLatestChannelItems"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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<ItemFilter> filters = Arrays.asList(); // List<ItemFilter> | Optional. Specify additional filters to apply.
|
||||
List<ItemFields> fields = Arrays.asList(); // List<ItemFields> | Optional. Specify additional fields of information to return in the output.
|
||||
List<UUID> channelIds = Arrays.asList(); // List<UUID> | 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 | - |
|
||||
|
||||
@ -0,0 +1,18 @@
|
||||
|
||||
|
||||
# ChapterInfo
|
||||
|
||||
Class ChapterInfo.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**startPositionTicks** | **Long** | Gets or sets the start position ticks. | [optional] |
|
||||
|**name** | **String** | Gets or sets the name. | [optional] |
|
||||
|**imagePath** | **String** | Gets or sets the image path. | [optional] |
|
||||
|**imageDateModified** | **OffsetDateTime** | | [optional] |
|
||||
|**imageTag** | **String** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# ClientCapabilities
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**playableMediaTypes** | **List<String>** | | [optional] |
|
||||
|**supportedCommands** | **List<GeneralCommandType>** | | [optional] |
|
||||
|**supportsMediaControl** | **Boolean** | | [optional] |
|
||||
|**supportsContentUploading** | **Boolean** | | [optional] |
|
||||
|**messageCallbackUrl** | **String** | | [optional] |
|
||||
|**supportsPersistentIdentifier** | **Boolean** | | [optional] |
|
||||
|**supportsSync** | **Boolean** | | [optional] |
|
||||
|**deviceProfile** | [**DeviceProfile**](DeviceProfile.md) | A MediaBrowser.Model.Dlna.DeviceProfile represents a set of metadata which determines which content a certain device is able to play. <br /> Specifically, it defines the supported <see cref=\"P:MediaBrowser.Model.Dlna.DeviceProfile.ContainerProfiles\">containers</see> and <see cref=\"P:MediaBrowser.Model.Dlna.DeviceProfile.CodecProfiles\">codecs</see> (video and/or audio, including codec profiles and levels) the device is able to direct play (without transcoding or remuxing), as well as which <see cref=\"P:MediaBrowser.Model.Dlna.DeviceProfile.TranscodingProfiles\">containers/codecs to transcode to</see> in case it isn't. | [optional] |
|
||||
|**appStoreUrl** | **String** | | [optional] |
|
||||
|**iconUrl** | **String** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,23 @@
|
||||
|
||||
|
||||
# ClientCapabilitiesDto
|
||||
|
||||
Client capabilities dto.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**playableMediaTypes** | **List<String>** | 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] |
|
||||
|**supportsContentUploading** | **Boolean** | Gets or sets a value indicating whether session supports content uploading. | [optional] |
|
||||
|**messageCallbackUrl** | **String** | Gets or sets the message callback url. | [optional] |
|
||||
|**supportsPersistentIdentifier** | **Boolean** | Gets or sets a value indicating whether session supports a persistent identifier. | [optional] |
|
||||
|**supportsSync** | **Boolean** | Gets or sets a value indicating whether session supports sync. | [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] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,79 @@
|
||||
# ClientLogApi
|
||||
|
||||
All URIs are relative to *http://nuc.ehrendingen:8096*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
|------------- | ------------- | -------------|
|
||||
| [**logFile**](ClientLogApi.md#logFile) | **POST** /ClientLog/Document | Upload a document. |
|
||||
|
||||
|
||||
<a id="logFile"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
@ -0,0 +1,14 @@
|
||||
|
||||
|
||||
# ClientLogDocumentResponseDto
|
||||
|
||||
Client log document response dto.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**fileName** | **String** | Gets the resulting filename. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,17 @@
|
||||
|
||||
|
||||
# CodecProfile
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**type** | **CodecType** | | [optional] |
|
||||
|**conditions** | [**List<ProfileCondition>**](ProfileCondition.md) | | [optional] |
|
||||
|**applyConditions** | [**List<ProfileCondition>**](ProfileCondition.md) | | [optional] |
|
||||
|**codec** | **String** | | [optional] |
|
||||
|**container** | **String** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,15 @@
|
||||
|
||||
|
||||
# CodecType
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `VIDEO` (value: `"Video"`)
|
||||
|
||||
* `VIDEO_AUDIO` (value: `"VideoAudio"`)
|
||||
|
||||
* `AUDIO` (value: `"Audio"`)
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,226 @@
|
||||
# CollectionApi
|
||||
|
||||
All URIs are relative to *http://nuc.ehrendingen:8096*
|
||||
|
||||
| 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. |
|
||||
|
||||
|
||||
<a id="addToCollection"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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<UUID> ids = Arrays.asList(); // List<UUID> | 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 | - |
|
||||
|
||||
<a id="createCollection"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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<String> ids = Arrays.asList(); // List<String> | 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 | - |
|
||||
|
||||
<a id="removeFromCollection"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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<UUID> ids = Arrays.asList(); // List<UUID> | 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 | - |
|
||||
|
||||
@ -0,0 +1,13 @@
|
||||
|
||||
|
||||
# CollectionCreationResult
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**id** | **UUID** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,25 @@
|
||||
|
||||
|
||||
# CollectionTypeOptions
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `MOVIES` (value: `"Movies"`)
|
||||
|
||||
* `TV_SHOWS` (value: `"TvShows"`)
|
||||
|
||||
* `MUSIC` (value: `"Music"`)
|
||||
|
||||
* `MUSIC_VIDEOS` (value: `"MusicVideos"`)
|
||||
|
||||
* `HOME_VIDEOS` (value: `"HomeVideos"`)
|
||||
|
||||
* `BOX_SETS` (value: `"BoxSets"`)
|
||||
|
||||
* `BOOKS` (value: `"Books"`)
|
||||
|
||||
* `MIXED` (value: `"Mixed"`)
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,19 @@
|
||||
|
||||
|
||||
# ConfigImageTypes
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**backdropSizes** | **List<String>** | | [optional] |
|
||||
|**baseUrl** | **String** | | [optional] |
|
||||
|**logoSizes** | **List<String>** | | [optional] |
|
||||
|**posterSizes** | **List<String>** | | [optional] |
|
||||
|**profileSizes** | **List<String>** | | [optional] |
|
||||
|**secureBaseUrl** | **String** | | [optional] |
|
||||
|**stillSizes** | **List<String>** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,419 @@
|
||||
# ConfigurationApi
|
||||
|
||||
All URIs are relative to *http://nuc.ehrendingen:8096*
|
||||
|
||||
| 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. |
|
||||
| [**updateMediaEncoderPath**](ConfigurationApi.md#updateMediaEncoderPath) | **POST** /System/MediaEncoder/Path | Updates the path to the media encoder. |
|
||||
| [**updateNamedConfiguration**](ConfigurationApi.md#updateNamedConfiguration) | **POST** /System/Configuration/{key} | Updates named configuration. |
|
||||
|
||||
|
||||
<a id="getConfiguration"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
<a id="getDefaultMetadataOptions"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
<a id="getNamedConfiguration"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
<a id="updateConfiguration"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
<a id="updateMediaEncoderPath"></a>
|
||||
# **updateMediaEncoderPath**
|
||||
> updateMediaEncoderPath(mediaEncoderPathDto)
|
||||
|
||||
Updates the path to the media encoder.
|
||||
|
||||
### Example
|
||||
```java
|
||||
// Import classes:
|
||||
import org.openapitools.client.ApiClient;
|
||||
import 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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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);
|
||||
MediaEncoderPathDto mediaEncoderPathDto = new MediaEncoderPathDto(); // MediaEncoderPathDto | Media encoder path form body.
|
||||
try {
|
||||
apiInstance.updateMediaEncoderPath(mediaEncoderPathDto);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling ConfigurationApi#updateMediaEncoderPath");
|
||||
System.err.println("Status code: " + e.getCode());
|
||||
System.err.println("Reason: " + e.getResponseBody());
|
||||
System.err.println("Response headers: " + e.getResponseHeaders());
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **mediaEncoderPathDto** | [**MediaEncoderPathDto**](MediaEncoderPathDto.md)| Media encoder path form body. | |
|
||||
|
||||
### 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 encoder path updated. | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | Forbidden | - |
|
||||
|
||||
<a id="updateNamedConfiguration"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
@ -0,0 +1,19 @@
|
||||
|
||||
|
||||
# ConfigurationPageInfo
|
||||
|
||||
The configuration page info.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | Gets or sets the name. | [optional] |
|
||||
|**enableInMainMenu** | **Boolean** | Gets or sets a value indicating whether the configurations page is enabled in the main menu. | [optional] |
|
||||
|**menuSection** | **String** | Gets or sets the menu section. | [optional] |
|
||||
|**menuIcon** | **String** | Gets or sets the menu icon. | [optional] |
|
||||
|**displayName** | **String** | Gets or sets the display name. | [optional] |
|
||||
|**pluginId** | **UUID** | Gets or sets the plugin id. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,15 @@
|
||||
|
||||
|
||||
# ContainerProfile
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**type** | **DlnaProfileType** | | [optional] |
|
||||
|**conditions** | [**List<ProfileCondition>**](ProfileCondition.md) | | [optional] |
|
||||
|**container** | **String** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,15 @@
|
||||
|
||||
|
||||
# ControlResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**headers** | **Map<String, String>** | | [optional] [readonly] |
|
||||
|**xml** | **String** | | [optional] |
|
||||
|**isSuccessful** | **Boolean** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,17 @@
|
||||
|
||||
|
||||
# CountryInfo
|
||||
|
||||
Class CountryInfo.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | Gets or sets the name. | [optional] |
|
||||
|**displayName** | **String** | Gets or sets the display name. | [optional] |
|
||||
|**twoLetterISORegionName** | **String** | Gets or sets the name of the two letter ISO region. | [optional] |
|
||||
|**threeLetterISORegionName** | **String** | Gets or sets the name of the three letter ISO region. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,17 @@
|
||||
|
||||
|
||||
# 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** | **String** | Gets or sets the media type. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,15 @@
|
||||
|
||||
|
||||
# CreateUserByName
|
||||
|
||||
The create user by name request body.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | Gets or sets the username. | [optional] |
|
||||
|**password** | **String** | Gets or sets the password. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,18 @@
|
||||
|
||||
|
||||
# CultureDto
|
||||
|
||||
Class CultureDto.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | Gets the name. | [optional] |
|
||||
|**displayName** | **String** | Gets the display name. | [optional] |
|
||||
|**twoLetterISOLanguageName** | **String** | Gets the name of the two letter ISO language. | [optional] |
|
||||
|**threeLetterISOLanguageName** | **String** | Gets the name of the three letter ISO language. | [optional] [readonly] |
|
||||
|**threeLetterISOLanguageNames** | **List<String>** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,14 @@
|
||||
|
||||
|
||||
# CustomQueryData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**customQueryString** | **String** | | [optional] |
|
||||
|**replaceUserId** | **Boolean** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,141 @@
|
||||
# DashboardApi
|
||||
|
||||
All URIs are relative to *http://nuc.ehrendingen:8096*
|
||||
|
||||
| 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. |
|
||||
|
||||
|
||||
<a id="getConfigurationPages"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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<ConfigurationPageInfo> 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 | - |
|
||||
|
||||
<a id="getDashboardConfigurationPage"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
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. | - |
|
||||
|
||||
@ -0,0 +1,23 @@
|
||||
|
||||
|
||||
# DayOfWeek
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `SUNDAY` (value: `"Sunday"`)
|
||||
|
||||
* `MONDAY` (value: `"Monday"`)
|
||||
|
||||
* `TUESDAY` (value: `"Tuesday"`)
|
||||
|
||||
* `WEDNESDAY` (value: `"Wednesday"`)
|
||||
|
||||
* `THURSDAY` (value: `"Thursday"`)
|
||||
|
||||
* `FRIDAY` (value: `"Friday"`)
|
||||
|
||||
* `SATURDAY` (value: `"Saturday"`)
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,15 @@
|
||||
|
||||
|
||||
# DayPattern
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `DAILY` (value: `"Daily"`)
|
||||
|
||||
* `WEEKDAYS` (value: `"Weekdays"`)
|
||||
|
||||
* `WEEKENDS` (value: `"Weekends"`)
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,14 @@
|
||||
|
||||
|
||||
# DefaultDirectoryBrowserInfoDto
|
||||
|
||||
Default directory browser info.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**path** | **String** | Gets or sets the path. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,21 @@
|
||||
|
||||
|
||||
# DeviceIdentification
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**friendlyName** | **String** | Gets or sets the name of the friendly. | [optional] |
|
||||
|**modelNumber** | **String** | Gets or sets the model number. | [optional] |
|
||||
|**serialNumber** | **String** | Gets or sets the serial number. | [optional] |
|
||||
|**modelName** | **String** | Gets or sets the name of the model. | [optional] |
|
||||
|**modelDescription** | **String** | Gets or sets the model description. | [optional] |
|
||||
|**modelUrl** | **String** | Gets or sets the model URL. | [optional] |
|
||||
|**manufacturer** | **String** | Gets or sets the manufacturer. | [optional] |
|
||||
|**manufacturerUrl** | **String** | Gets or sets the manufacturer URL. | [optional] |
|
||||
|**headers** | [**List<HttpHeaderInfo>**](HttpHeaderInfo.md) | Gets or sets the headers. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,22 @@
|
||||
|
||||
|
||||
# DeviceInfo
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | | [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** | [**ClientCapabilities**](ClientCapabilities.md) | Gets or sets the capabilities. | [optional] |
|
||||
|**iconUrl** | **String** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,15 @@
|
||||
|
||||
|
||||
# DeviceInfoQueryResult
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**items** | [**List<DeviceInfo>**](DeviceInfo.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] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,16 @@
|
||||
|
||||
|
||||
# DeviceOptions
|
||||
|
||||
An entity representing custom options for a device.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**id** | **Integer** | Gets the id. | [optional] [readonly] |
|
||||
|**deviceId** | **String** | Gets the device id. | [optional] |
|
||||
|**customName** | **String** | Gets or sets the custom name. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,16 @@
|
||||
|
||||
|
||||
# DeviceOptionsDto
|
||||
|
||||
A dto representing custom options for a device.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**id** | **Integer** | Gets or sets the id. | [optional] |
|
||||
|**deviceId** | **String** | Gets or sets the device id. | [optional] |
|
||||
|**customName** | **String** | Gets or sets the custom name. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,52 @@
|
||||
|
||||
|
||||
# DeviceProfile
|
||||
|
||||
A MediaBrowser.Model.Dlna.DeviceProfile represents a set of metadata which determines which content a certain device is able to play. <br /> Specifically, it defines the supported <see cref=\"P:MediaBrowser.Model.Dlna.DeviceProfile.ContainerProfiles\">containers</see> and <see cref=\"P:MediaBrowser.Model.Dlna.DeviceProfile.CodecProfiles\">codecs</see> (video and/or audio, including codec profiles and levels) the device is able to direct play (without transcoding or remuxing), as well as which <see cref=\"P:MediaBrowser.Model.Dlna.DeviceProfile.TranscodingProfiles\">containers/codecs to transcode to</see> in case it isn't.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | Gets or sets the name of this device profile. | [optional] |
|
||||
|**id** | **String** | Gets or sets the Id. | [optional] |
|
||||
|**identification** | [**DeviceIdentification**](DeviceIdentification.md) | Gets or sets the Identification. | [optional] |
|
||||
|**friendlyName** | **String** | Gets or sets the friendly name of the device profile, which can be shown to users. | [optional] |
|
||||
|**manufacturer** | **String** | Gets or sets the manufacturer of the device which this profile represents. | [optional] |
|
||||
|**manufacturerUrl** | **String** | Gets or sets an url for the manufacturer of the device which this profile represents. | [optional] |
|
||||
|**modelName** | **String** | Gets or sets the model name of the device which this profile represents. | [optional] |
|
||||
|**modelDescription** | **String** | Gets or sets the model description of the device which this profile represents. | [optional] |
|
||||
|**modelNumber** | **String** | Gets or sets the model number of the device which this profile represents. | [optional] |
|
||||
|**modelUrl** | **String** | Gets or sets the ModelUrl. | [optional] |
|
||||
|**serialNumber** | **String** | Gets or sets the serial number of the device which this profile represents. | [optional] |
|
||||
|**enableAlbumArtInDidl** | **Boolean** | Gets or sets a value indicating whether EnableAlbumArtInDidl. | [optional] |
|
||||
|**enableSingleAlbumArtLimit** | **Boolean** | Gets or sets a value indicating whether EnableSingleAlbumArtLimit. | [optional] |
|
||||
|**enableSingleSubtitleLimit** | **Boolean** | Gets or sets a value indicating whether EnableSingleSubtitleLimit. | [optional] |
|
||||
|**supportedMediaTypes** | **String** | Gets or sets the SupportedMediaTypes. | [optional] |
|
||||
|**userId** | **String** | Gets or sets the UserId. | [optional] |
|
||||
|**albumArtPn** | **String** | Gets or sets the AlbumArtPn. | [optional] |
|
||||
|**maxAlbumArtWidth** | **Integer** | Gets or sets the MaxAlbumArtWidth. | [optional] |
|
||||
|**maxAlbumArtHeight** | **Integer** | Gets or sets the MaxAlbumArtHeight. | [optional] |
|
||||
|**maxIconWidth** | **Integer** | Gets or sets the maximum allowed width of embedded icons. | [optional] |
|
||||
|**maxIconHeight** | **Integer** | Gets or sets the maximum allowed height of embedded icons. | [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] |
|
||||
|**sonyAggregationFlags** | **String** | Gets or sets the content of the aggregationFlags element in the urn:schemas-sonycom:av namespace. | [optional] |
|
||||
|**protocolInfo** | **String** | Gets or sets the ProtocolInfo. | [optional] |
|
||||
|**timelineOffsetSeconds** | **Integer** | Gets or sets the TimelineOffsetSeconds. | [optional] |
|
||||
|**requiresPlainVideoItems** | **Boolean** | Gets or sets a value indicating whether RequiresPlainVideoItems. | [optional] |
|
||||
|**requiresPlainFolders** | **Boolean** | Gets or sets a value indicating whether RequiresPlainFolders. | [optional] |
|
||||
|**enableMSMediaReceiverRegistrar** | **Boolean** | Gets or sets a value indicating whether EnableMSMediaReceiverRegistrar. | [optional] |
|
||||
|**ignoreTranscodeByteRangeRequests** | **Boolean** | Gets or sets a value indicating whether IgnoreTranscodeByteRangeRequests. | [optional] |
|
||||
|**xmlRootAttributes** | [**List<XmlAttribute>**](XmlAttribute.md) | Gets or sets the XmlRootAttributes. | [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. | [optional] |
|
||||
|**codecProfiles** | [**List<CodecProfile>**](CodecProfile.md) | Gets or sets the codec profiles. | [optional] |
|
||||
|**responseProfiles** | [**List<ResponseProfile>**](ResponseProfile.md) | Gets or sets the ResponseProfiles. | [optional] |
|
||||
|**subtitleProfiles** | [**List<SubtitleProfile>**](SubtitleProfile.md) | Gets or sets the subtitle profiles. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,15 @@
|
||||
|
||||
|
||||
# DeviceProfileInfo
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**id** | **String** | Gets or sets the identifier. | [optional] |
|
||||
|**name** | **String** | Gets or sets the name. | [optional] |
|
||||
|**type** | **DeviceProfileType** | Gets or sets the type. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,13 @@
|
||||
|
||||
|
||||
# DeviceProfileType
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `SYSTEM` (value: `"System"`)
|
||||
|
||||
* `USER` (value: `"User"`)
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,363 @@
|
||||
# DevicesApi
|
||||
|
||||
All URIs are relative to *http://nuc.ehrendingen:8096*
|
||||
|
||||
| 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. |
|
||||
|
||||
|
||||
<a id="deleteDevice"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
<a id="getDeviceInfo"></a>
|
||||
# **getDeviceInfo**
|
||||
> DeviceInfo 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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 {
|
||||
DeviceInfo 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
|
||||
|
||||
[**DeviceInfo**](DeviceInfo.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 | - |
|
||||
|
||||
<a id="getDeviceOptions"></a>
|
||||
# **getDeviceOptions**
|
||||
> DeviceOptions 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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 {
|
||||
DeviceOptions 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
|
||||
|
||||
[**DeviceOptions**](DeviceOptions.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 | - |
|
||||
|
||||
<a id="getDevices"></a>
|
||||
# **getDevices**
|
||||
> DeviceInfoQueryResult getDevices(supportsSync, 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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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);
|
||||
Boolean supportsSync = true; // Boolean | Gets or sets a value indicating whether [supports synchronize].
|
||||
UUID userId = UUID.randomUUID(); // UUID | Gets or sets the user identifier.
|
||||
try {
|
||||
DeviceInfoQueryResult result = apiInstance.getDevices(supportsSync, 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 |
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **supportsSync** | **Boolean**| Gets or sets a value indicating whether [supports synchronize]. | [optional] |
|
||||
| **userId** | **UUID**| Gets or sets the user identifier. | [optional] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DeviceInfoQueryResult**](DeviceInfoQueryResult.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 | - |
|
||||
|
||||
<a id="updateDeviceOptions"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
@ -0,0 +1,16 @@
|
||||
|
||||
|
||||
# DirectPlayProfile
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**container** | **String** | | [optional] |
|
||||
|**audioCodec** | **String** | | [optional] |
|
||||
|**videoCodec** | **String** | | [optional] |
|
||||
|**type** | **DlnaProfileType** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,157 @@
|
||||
# DisplayPreferencesApi
|
||||
|
||||
All URIs are relative to *http://nuc.ehrendingen:8096*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
|------------- | ------------- | -------------|
|
||||
| [**getDisplayPreferences**](DisplayPreferencesApi.md#getDisplayPreferences) | **GET** /DisplayPreferences/{displayPreferencesId} | Get Display Preferences. |
|
||||
| [**updateDisplayPreferences**](DisplayPreferencesApi.md#updateDisplayPreferences) | **POST** /DisplayPreferences/{displayPreferencesId} | Update Display Preferences. |
|
||||
|
||||
|
||||
<a id="getDisplayPreferences"></a>
|
||||
# **getDisplayPreferences**
|
||||
> DisplayPreferencesDto getDisplayPreferences(displayPreferencesId, userId, client)
|
||||
|
||||
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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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.
|
||||
UUID userId = UUID.randomUUID(); // UUID | User id.
|
||||
String client = "client_example"; // String | Client.
|
||||
try {
|
||||
DisplayPreferencesDto result = apiInstance.getDisplayPreferences(displayPreferencesId, userId, client);
|
||||
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. | |
|
||||
| **userId** | **UUID**| User id. | |
|
||||
| **client** | **String**| Client. | |
|
||||
|
||||
### 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 | - |
|
||||
|
||||
<a id="updateDisplayPreferences"></a>
|
||||
# **updateDisplayPreferences**
|
||||
> updateDisplayPreferences(displayPreferencesId, userId, client, displayPreferencesDto)
|
||||
|
||||
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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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.
|
||||
UUID userId = UUID.randomUUID(); // UUID | User Id.
|
||||
String client = "client_example"; // String | Client.
|
||||
DisplayPreferencesDto displayPreferencesDto = new DisplayPreferencesDto(); // DisplayPreferencesDto | New Display Preferences object.
|
||||
try {
|
||||
apiInstance.updateDisplayPreferences(displayPreferencesId, userId, client, displayPreferencesDto);
|
||||
} 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. | |
|
||||
| **userId** | **UUID**| User Id. | |
|
||||
| **client** | **String**| Client. | |
|
||||
| **displayPreferencesDto** | [**DisplayPreferencesDto**](DisplayPreferencesDto.md)| New Display Preferences object. | |
|
||||
|
||||
### 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 | - |
|
||||
|
||||
@ -0,0 +1,27 @@
|
||||
|
||||
|
||||
# DisplayPreferencesDto
|
||||
|
||||
Defines the display preferences for any item that supports them (usually Folders).
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**id** | **String** | Gets or sets the user id. | [optional] |
|
||||
|**viewType** | **String** | Gets or sets the type of the view. | [optional] |
|
||||
|**sortBy** | **String** | Gets or sets the sort by. | [optional] |
|
||||
|**indexBy** | **String** | Gets or sets the index by. | [optional] |
|
||||
|**rememberIndexing** | **Boolean** | Gets or sets a value indicating whether [remember indexing]. | [optional] |
|
||||
|**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] |
|
||||
|**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] |
|
||||
|**showSidebar** | **Boolean** | Gets or sets a value indicating whether [show sidebar]. | [optional] |
|
||||
|**client** | **String** | Gets or sets the client. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,422 @@
|
||||
# DlnaApi
|
||||
|
||||
All URIs are relative to *http://nuc.ehrendingen:8096*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
|------------- | ------------- | -------------|
|
||||
| [**createProfile**](DlnaApi.md#createProfile) | **POST** /Dlna/Profiles | Creates a profile. |
|
||||
| [**deleteProfile**](DlnaApi.md#deleteProfile) | **DELETE** /Dlna/Profiles/{profileId} | Deletes a profile. |
|
||||
| [**getDefaultProfile**](DlnaApi.md#getDefaultProfile) | **GET** /Dlna/Profiles/Default | Gets the default profile. |
|
||||
| [**getProfile**](DlnaApi.md#getProfile) | **GET** /Dlna/Profiles/{profileId} | Gets a single profile. |
|
||||
| [**getProfileInfos**](DlnaApi.md#getProfileInfos) | **GET** /Dlna/ProfileInfos | Get profile infos. |
|
||||
| [**updateProfile**](DlnaApi.md#updateProfile) | **POST** /Dlna/Profiles/{profileId} | Updates a profile. |
|
||||
|
||||
|
||||
<a id="createProfile"></a>
|
||||
# **createProfile**
|
||||
> createProfile(deviceProfile)
|
||||
|
||||
Creates a profile.
|
||||
|
||||
### Example
|
||||
```java
|
||||
// Import classes:
|
||||
import org.openapitools.client.ApiClient;
|
||||
import org.openapitools.client.ApiException;
|
||||
import org.openapitools.client.Configuration;
|
||||
import org.openapitools.client.auth.*;
|
||||
import org.openapitools.client.models.*;
|
||||
import org.openapitools.client.api.DlnaApi;
|
||||
|
||||
public class Example {
|
||||
public static void main(String[] args) {
|
||||
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
||||
defaultClient.setBasePath("http://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("YOUR API KEY");
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//CustomAuthentication.setApiKeyPrefix("Token");
|
||||
|
||||
DlnaApi apiInstance = new DlnaApi(defaultClient);
|
||||
DeviceProfile deviceProfile = new DeviceProfile(); // DeviceProfile | Device profile.
|
||||
try {
|
||||
apiInstance.createProfile(deviceProfile);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling DlnaApi#createProfile");
|
||||
System.err.println("Status code: " + e.getCode());
|
||||
System.err.println("Reason: " + e.getResponseBody());
|
||||
System.err.println("Response headers: " + e.getResponseHeaders());
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **deviceProfile** | [**DeviceProfile**](DeviceProfile.md)| Device profile. | [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** | Device profile created. | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | Forbidden | - |
|
||||
|
||||
<a id="deleteProfile"></a>
|
||||
# **deleteProfile**
|
||||
> deleteProfile(profileId)
|
||||
|
||||
Deletes a profile.
|
||||
|
||||
### Example
|
||||
```java
|
||||
// Import classes:
|
||||
import org.openapitools.client.ApiClient;
|
||||
import org.openapitools.client.ApiException;
|
||||
import org.openapitools.client.Configuration;
|
||||
import org.openapitools.client.auth.*;
|
||||
import org.openapitools.client.models.*;
|
||||
import org.openapitools.client.api.DlnaApi;
|
||||
|
||||
public class Example {
|
||||
public static void main(String[] args) {
|
||||
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
||||
defaultClient.setBasePath("http://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("YOUR API KEY");
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//CustomAuthentication.setApiKeyPrefix("Token");
|
||||
|
||||
DlnaApi apiInstance = new DlnaApi(defaultClient);
|
||||
String profileId = "profileId_example"; // String | Profile id.
|
||||
try {
|
||||
apiInstance.deleteProfile(profileId);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling DlnaApi#deleteProfile");
|
||||
System.err.println("Status code: " + e.getCode());
|
||||
System.err.println("Reason: " + e.getResponseBody());
|
||||
System.err.println("Response headers: " + e.getResponseHeaders());
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **profileId** | **String**| Profile 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 profile deleted. | - |
|
||||
| **404** | Device profile not found. | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | Forbidden | - |
|
||||
|
||||
<a id="getDefaultProfile"></a>
|
||||
# **getDefaultProfile**
|
||||
> DeviceProfile getDefaultProfile()
|
||||
|
||||
Gets the default profile.
|
||||
|
||||
### Example
|
||||
```java
|
||||
// Import classes:
|
||||
import org.openapitools.client.ApiClient;
|
||||
import org.openapitools.client.ApiException;
|
||||
import org.openapitools.client.Configuration;
|
||||
import org.openapitools.client.auth.*;
|
||||
import org.openapitools.client.models.*;
|
||||
import org.openapitools.client.api.DlnaApi;
|
||||
|
||||
public class Example {
|
||||
public static void main(String[] args) {
|
||||
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
||||
defaultClient.setBasePath("http://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("YOUR API KEY");
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//CustomAuthentication.setApiKeyPrefix("Token");
|
||||
|
||||
DlnaApi apiInstance = new DlnaApi(defaultClient);
|
||||
try {
|
||||
DeviceProfile result = apiInstance.getDefaultProfile();
|
||||
System.out.println(result);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling DlnaApi#getDefaultProfile");
|
||||
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
|
||||
|
||||
[**DeviceProfile**](DeviceProfile.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 device profile returned. | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | Forbidden | - |
|
||||
|
||||
<a id="getProfile"></a>
|
||||
# **getProfile**
|
||||
> DeviceProfile getProfile(profileId)
|
||||
|
||||
Gets a single profile.
|
||||
|
||||
### Example
|
||||
```java
|
||||
// Import classes:
|
||||
import org.openapitools.client.ApiClient;
|
||||
import org.openapitools.client.ApiException;
|
||||
import org.openapitools.client.Configuration;
|
||||
import org.openapitools.client.auth.*;
|
||||
import org.openapitools.client.models.*;
|
||||
import org.openapitools.client.api.DlnaApi;
|
||||
|
||||
public class Example {
|
||||
public static void main(String[] args) {
|
||||
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
||||
defaultClient.setBasePath("http://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("YOUR API KEY");
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//CustomAuthentication.setApiKeyPrefix("Token");
|
||||
|
||||
DlnaApi apiInstance = new DlnaApi(defaultClient);
|
||||
String profileId = "profileId_example"; // String | Profile Id.
|
||||
try {
|
||||
DeviceProfile result = apiInstance.getProfile(profileId);
|
||||
System.out.println(result);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling DlnaApi#getProfile");
|
||||
System.err.println("Status code: " + e.getCode());
|
||||
System.err.println("Reason: " + e.getResponseBody());
|
||||
System.err.println("Response headers: " + e.getResponseHeaders());
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **profileId** | **String**| Profile Id. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DeviceProfile**](DeviceProfile.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 profile returned. | - |
|
||||
| **404** | Device profile not found. | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | Forbidden | - |
|
||||
|
||||
<a id="getProfileInfos"></a>
|
||||
# **getProfileInfos**
|
||||
> List<DeviceProfileInfo> getProfileInfos()
|
||||
|
||||
Get profile 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.DlnaApi;
|
||||
|
||||
public class Example {
|
||||
public static void main(String[] args) {
|
||||
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
||||
defaultClient.setBasePath("http://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("YOUR API KEY");
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//CustomAuthentication.setApiKeyPrefix("Token");
|
||||
|
||||
DlnaApi apiInstance = new DlnaApi(defaultClient);
|
||||
try {
|
||||
List<DeviceProfileInfo> result = apiInstance.getProfileInfos();
|
||||
System.out.println(result);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling DlnaApi#getProfileInfos");
|
||||
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<DeviceProfileInfo>**](DeviceProfileInfo.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 profile infos returned. | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | Forbidden | - |
|
||||
|
||||
<a id="updateProfile"></a>
|
||||
# **updateProfile**
|
||||
> updateProfile(profileId, deviceProfile)
|
||||
|
||||
Updates a profile.
|
||||
|
||||
### Example
|
||||
```java
|
||||
// Import classes:
|
||||
import org.openapitools.client.ApiClient;
|
||||
import org.openapitools.client.ApiException;
|
||||
import org.openapitools.client.Configuration;
|
||||
import org.openapitools.client.auth.*;
|
||||
import org.openapitools.client.models.*;
|
||||
import org.openapitools.client.api.DlnaApi;
|
||||
|
||||
public class Example {
|
||||
public static void main(String[] args) {
|
||||
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
||||
defaultClient.setBasePath("http://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("YOUR API KEY");
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//CustomAuthentication.setApiKeyPrefix("Token");
|
||||
|
||||
DlnaApi apiInstance = new DlnaApi(defaultClient);
|
||||
String profileId = "profileId_example"; // String | Profile id.
|
||||
DeviceProfile deviceProfile = new DeviceProfile(); // DeviceProfile | Device profile.
|
||||
try {
|
||||
apiInstance.updateProfile(profileId, deviceProfile);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling DlnaApi#updateProfile");
|
||||
System.err.println("Status code: " + e.getCode());
|
||||
System.err.println("Reason: " + e.getResponseBody());
|
||||
System.err.println("Response headers: " + e.getResponseHeaders());
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **profileId** | **String**| Profile id. | |
|
||||
| **deviceProfile** | [**DeviceProfile**](DeviceProfile.md)| Device profile. | [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** | Device profile updated. | - |
|
||||
| **404** | Device profile not found. | - |
|
||||
| **401** | Unauthorized | - |
|
||||
| **403** | Forbidden | - |
|
||||
|
||||
@ -0,0 +1,24 @@
|
||||
|
||||
|
||||
# DlnaOptions
|
||||
|
||||
The DlnaOptions class contains the user definable parameters for the dlna subsystems.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**enablePlayTo** | **Boolean** | Gets or sets a value indicating whether gets or sets a value to indicate the status of the dlna playTo subsystem. | [optional] |
|
||||
|**enableServer** | **Boolean** | Gets or sets a value indicating whether gets or sets a value to indicate the status of the dlna server subsystem. | [optional] |
|
||||
|**enableDebugLog** | **Boolean** | Gets or sets a value indicating whether detailed dlna server logs are sent to the console/log. If the setting \"Emby.Dlna\": \"Debug\" msut be set in logging.default.json for this property to work. | [optional] |
|
||||
|**enablePlayToTracing** | **Boolean** | Gets or sets a value indicating whether whether detailed playTo debug logs are sent to the console/log. If the setting \"Emby.Dlna.PlayTo\": \"Debug\" msut be set in logging.default.json for this property to work. | [optional] |
|
||||
|**clientDiscoveryIntervalSeconds** | **Integer** | Gets or sets the ssdp client discovery interval time (in seconds). This is the time after which the server will send a ssdp search request. | [optional] |
|
||||
|**aliveMessageIntervalSeconds** | **Integer** | Gets or sets the frequency at which ssdp alive notifications are transmitted. | [optional] |
|
||||
|**blastAliveMessageIntervalSeconds** | **Integer** | Gets or sets the frequency at which ssdp alive notifications are transmitted. MIGRATING - TO BE REMOVED ONCE WEB HAS BEEN ALTERED. | [optional] |
|
||||
|**defaultUserId** | **String** | Gets or sets the default user account that the dlna server uses. | [optional] |
|
||||
|**autoCreatePlayToProfiles** | **Boolean** | Gets or sets a value indicating whether playTo device profiles should be created. | [optional] |
|
||||
|**blastAliveMessages** | **Boolean** | Gets or sets a value indicating whether to blast alive messages. | [optional] |
|
||||
|**sendOnlyMatchedHost** | **Boolean** | gets or sets a value indicating whether to send only matched host. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,17 @@
|
||||
|
||||
|
||||
# DlnaProfileType
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `AUDIO` (value: `"Audio"`)
|
||||
|
||||
* `VIDEO` (value: `"Video"`)
|
||||
|
||||
* `PHOTO` (value: `"Photo"`)
|
||||
|
||||
* `SUBTITLE` (value: `"Subtitle"`)
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,29 @@
|
||||
|
||||
|
||||
# DynamicDayOfWeek
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `SUNDAY` (value: `"Sunday"`)
|
||||
|
||||
* `MONDAY` (value: `"Monday"`)
|
||||
|
||||
* `TUESDAY` (value: `"Tuesday"`)
|
||||
|
||||
* `WEDNESDAY` (value: `"Wednesday"`)
|
||||
|
||||
* `THURSDAY` (value: `"Thursday"`)
|
||||
|
||||
* `FRIDAY` (value: `"Friday"`)
|
||||
|
||||
* `SATURDAY` (value: `"Saturday"`)
|
||||
|
||||
* `EVERYDAY` (value: `"Everyday"`)
|
||||
|
||||
* `WEEKDAY` (value: `"Weekday"`)
|
||||
|
||||
* `WEEKEND` (value: `"Weekend"`)
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,17 @@
|
||||
|
||||
|
||||
# EmbeddedSubtitleOptions
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `ALLOW_ALL` (value: `"AllowAll"`)
|
||||
|
||||
* `ALLOW_TEXT` (value: `"AllowText"`)
|
||||
|
||||
* `ALLOW_IMAGE` (value: `"AllowImage"`)
|
||||
|
||||
* `ALLOW_NONE` (value: `"AllowNone"`)
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,13 @@
|
||||
|
||||
|
||||
# EncodingContext
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `STREAMING` (value: `"Streaming"`)
|
||||
|
||||
* `STATIC` (value: `"Static"`)
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,50 @@
|
||||
|
||||
|
||||
# EncodingOptions
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**encodingThreadCount** | **Integer** | | [optional] |
|
||||
|**transcodingTempPath** | **String** | | [optional] |
|
||||
|**fallbackFontPath** | **String** | | [optional] |
|
||||
|**enableFallbackFont** | **Boolean** | | [optional] |
|
||||
|**downMixAudioBoost** | **Double** | | [optional] |
|
||||
|**maxMuxingQueueSize** | **Integer** | | [optional] |
|
||||
|**enableThrottling** | **Boolean** | | [optional] |
|
||||
|**throttleDelaySeconds** | **Integer** | | [optional] |
|
||||
|**hardwareAccelerationType** | **String** | | [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** | | [optional] |
|
||||
|**enableTonemapping** | **Boolean** | | [optional] |
|
||||
|**enableVppTonemapping** | **Boolean** | | [optional] |
|
||||
|**tonemappingAlgorithm** | **String** | | [optional] |
|
||||
|**tonemappingMode** | **String** | | [optional] |
|
||||
|**tonemappingRange** | **String** | | [optional] |
|
||||
|**tonemappingDesat** | **Double** | | [optional] |
|
||||
|**tonemappingPeak** | **Double** | | [optional] |
|
||||
|**tonemappingParam** | **Double** | | [optional] |
|
||||
|**vppTonemappingBrightness** | **Double** | | [optional] |
|
||||
|**vppTonemappingContrast** | **Double** | | [optional] |
|
||||
|**h264Crf** | **Integer** | | [optional] |
|
||||
|**h265Crf** | **Integer** | | [optional] |
|
||||
|**encoderPreset** | **String** | | [optional] |
|
||||
|**deinterlaceDoubleRate** | **Boolean** | | [optional] |
|
||||
|**deinterlaceMethod** | **String** | | [optional] |
|
||||
|**enableDecodingColorDepth10Hevc** | **Boolean** | | [optional] |
|
||||
|**enableDecodingColorDepth10Vp9** | **Boolean** | | [optional] |
|
||||
|**enableEnhancedNvdecDecoder** | **Boolean** | | [optional] |
|
||||
|**preferSystemNativeHwDecoder** | **Boolean** | | [optional] |
|
||||
|**enableIntelLowPowerH264HwEncoder** | **Boolean** | | [optional] |
|
||||
|**enableIntelLowPowerHevcHwEncoder** | **Boolean** | | [optional] |
|
||||
|**enableHardwareEncoding** | **Boolean** | | [optional] |
|
||||
|**allowHevcEncoding** | **Boolean** | | [optional] |
|
||||
|**enableSubtitleExtraction** | **Boolean** | | [optional] |
|
||||
|**hardwareDecodingCodecs** | **List<String>** | | [optional] |
|
||||
|**allowOnDemandMetadataBasedKeyframeExtractionForExtensions** | **List<String>** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,14 @@
|
||||
|
||||
|
||||
# EndPointInfo
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**isLocal** | **Boolean** | | [optional] |
|
||||
|**isInNetwork** | **Boolean** | | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,420 @@
|
||||
# EnvironmentApi
|
||||
|
||||
All URIs are relative to *http://nuc.ehrendingen:8096*
|
||||
|
||||
| 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. |
|
||||
|
||||
|
||||
<a id="getDefaultDirectoryBrowser"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
<a id="getDirectoryContents"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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<FileSystemEntryInfo> 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 | - |
|
||||
|
||||
<a id="getDrives"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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<FileSystemEntryInfo> 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 | - |
|
||||
|
||||
<a id="getNetworkShares"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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<FileSystemEntryInfo> 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 | - |
|
||||
|
||||
<a id="getParentPath"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
<a id="validatePath"></a>
|
||||
# **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://nuc.ehrendingen:8096");
|
||||
|
||||
// Configure API key authorization: CustomAuthentication
|
||||
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
|
||||
CustomAuthentication.setApiKey("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 | - |
|
||||
|
||||
@ -0,0 +1,17 @@
|
||||
|
||||
|
||||
# ExternalIdInfo
|
||||
|
||||
Represents the external id information for serialization to the client.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | Gets or sets the display name of the external id provider (IE: IMDB, MusicBrainz, etc). | [optional] |
|
||||
|**key** | **String** | Gets or sets the unique key for this id. This key should be unique across all providers. | [optional] |
|
||||
|**type** | **ExternalIdMediaType** | Gets or sets the specific media type for this id. This is used to distinguish between the different external id types for providers with multiple ids. A null value indicates there is no specific media type associated with the external id, or this is the default id for the external provider so there is no need to specify a type. | [optional] |
|
||||
|**urlFormatString** | **String** | Gets or sets the URL format string. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,33 @@
|
||||
|
||||
|
||||
# ExternalIdMediaType
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `ALBUM` (value: `"Album"`)
|
||||
|
||||
* `ALBUM_ARTIST` (value: `"AlbumArtist"`)
|
||||
|
||||
* `ARTIST` (value: `"Artist"`)
|
||||
|
||||
* `BOX_SET` (value: `"BoxSet"`)
|
||||
|
||||
* `EPISODE` (value: `"Episode"`)
|
||||
|
||||
* `MOVIE` (value: `"Movie"`)
|
||||
|
||||
* `OTHER_ARTIST` (value: `"OtherArtist"`)
|
||||
|
||||
* `PERSON` (value: `"Person"`)
|
||||
|
||||
* `RELEASE_GROUP` (value: `"ReleaseGroup"`)
|
||||
|
||||
* `SEASON` (value: `"Season"`)
|
||||
|
||||
* `SERIES` (value: `"Series"`)
|
||||
|
||||
* `TRACK` (value: `"Track"`)
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,14 @@
|
||||
|
||||
|
||||
# ExternalUrl
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | Gets or sets the name. | [optional] |
|
||||
|**url** | **String** | Gets or sets the type of the item. | [optional] |
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,17 @@
|
||||
|
||||
|
||||
# FFmpegLocation
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `NOT_FOUND` (value: `"NotFound"`)
|
||||
|
||||
* `SET_BY_ARGUMENT` (value: `"SetByArgument"`)
|
||||
|
||||
* `CUSTOM` (value: `"Custom"`)
|
||||
|
||||
* `SYSTEM` (value: `"System"`)
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,16 @@
|
||||
|
||||
|
||||
# FileSystemEntryInfo
|
||||
|
||||
Class FileSystemEntryInfo.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|------------ | ------------- | ------------- | -------------|
|
||||
|**name** | **String** | Gets the name. | [optional] |
|
||||
|**path** | **String** | Gets the path. | [optional] |
|
||||
|**type** | **FileSystemEntryType** | Gets the type. | [optional] |
|
||||
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user