feat(api): openAPI code generator - poc (wip)

Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
This commit is contained in:
Patrik Gfeller 2024-12-27 20:44:36 +01:00
parent edebc031c9
commit dbc545396a
No known key found for this signature in database
GPG Key ID: 5EBA8954A87B9AEF
1634 changed files with 68978 additions and 81900 deletions

View File

@ -0,0 +1,47 @@
#!/usr/bin/bash
set -e
VERSIONS=("10.8.13" "10.10.3")
REQUIRED=("wget" "yq" "openapi-generator-cli")
function checkEnvironment() {
for i in "${REQUIRED[@]}"; do
if ! type $i &>/dev/null; then
echo "⚠️ [${i}] could not be found"
exit 127
fi
done
}
checkEnvironment
for i in "${VERSIONS[@]}"; do
echo " - API Version to generate: $i"
FILENAME_JSON="./specifications/json/jellyfin-openapi-${i}.json"
FILENAME_YAML="./specifications/yaml/jellyfin-openapi-${i}.yaml"
if [ ! -e "${FILENAME_JSON}" ]; then
echo "⏬ - Downloading OPENAPI definition for Version ${i}"
SERVER=https://repo.jellyfin.org/files/openapi/stable/jellyfin-openapi-${i}.json
wget \
--no-verbose \
--output-document=${FILENAME_JSON} \
${SERVER}
if [ ! -e "${FILENAME_YAML}" ]; then
echo "⚙️ - json ➡️ yaml"
yq -oy ${FILENAME_JSON} >${FILENAME_YAML}
fi
fi
echo "⚙️ - generate code for API ${i}"
# TODO: config.yaml - https://openapi-generator.tech/docs/customization
openapi-generator-cli generate -g java \
--global-property models,modelTests=false,apis,apiTests=false,library=native,serializationLibrary=jackson,apiPackage=org.openhab.binding.jellyfin.internal.api.${i} \
--input-spec ${FILENAME_YAML} -o ./generated/${i} 1>/dev/null
done

View File

@ -1,6 +1,6 @@
# ActivityLogApi # ActivityLogApi
All URIs are relative to *http://nuc.ehrendingen:8096* All URIs are relative to *http://localhost*
| Method | HTTP request | Description | | Method | HTTP request | Description |
|------------- | ------------- | -------------| |------------- | ------------- | -------------|
@ -26,7 +26,7 @@ import org.openapitools.client.api.ActivityLogApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");

View File

@ -0,0 +1,16 @@
# ActivityLogEntryMessage
Activity log created message.
## Properties
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**data** | [**List&lt;ActivityLogEntry&gt;**](ActivityLogEntry.md) | Gets or sets the data. | [optional] |
|**messageId** | **UUID** | Gets or sets the message id. | [optional] |
|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] |

View File

@ -0,0 +1,15 @@
# ActivityLogEntryStartMessage
Activity log entry start message. Data is the timing data encoded as \"$initialDelay,$interval\" in ms.
## Properties
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**data** | **String** | Gets or sets the data. | [optional] |
|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] |

View File

@ -0,0 +1,14 @@
# ActivityLogEntryStopMessage
Activity log entry stop message.
## Properties
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] |

View File

@ -1,6 +1,6 @@
# ApiKeyApi # ApiKeyApi
All URIs are relative to *http://nuc.ehrendingen:8096* All URIs are relative to *http://localhost*
| Method | HTTP request | Description | | Method | HTTP request | Description |
|------------- | ------------- | -------------| |------------- | ------------- | -------------|
@ -28,7 +28,7 @@ import org.openapitools.client.api.ApiKeyApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -96,7 +96,7 @@ import org.openapitools.client.api.ApiKeyApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -161,7 +161,7 @@ import org.openapitools.client.api.ApiKeyApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");

View File

@ -1,6 +1,6 @@
# ArtistsApi # ArtistsApi
All URIs are relative to *http://nuc.ehrendingen:8096* All URIs are relative to *http://localhost*
| Method | HTTP request | Description | | Method | HTTP request | Description |
|------------- | ------------- | -------------| |------------- | ------------- | -------------|
@ -28,7 +28,7 @@ import org.openapitools.client.api.ArtistsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -47,7 +47,7 @@ public class Example {
List<BaseItemKind> includeItemTypes = Arrays.asList(); // List<BaseItemKind> | Optional. If specified, results will be filtered 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. 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. 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<MediaType> mediaTypes = Arrays.asList(); // List<MediaType> | 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<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<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> officialRatings = Arrays.asList(); // List<String> | Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
@ -65,7 +65,7 @@ public class Example {
String nameStartsWithOrGreater = "nameStartsWithOrGreater_example"; // String | Optional filter by items whose name is sorted equally or greater than a given input string. 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 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. 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<ItemSortBy> sortBy = Arrays.asList(); // List<ItemSortBy> | Optional. Specify one or more sort orders, comma delimited.
List<SortOrder> sortOrder = Arrays.asList(); // List<SortOrder> | Sort Order - Ascending,Descending. List<SortOrder> sortOrder = Arrays.asList(); // List<SortOrder> | Sort Order - Ascending,Descending.
Boolean enableImages = true; // Boolean | Optional, include image information in output. Boolean enableImages = true; // Boolean | Optional, include image information in output.
Boolean enableTotalRecordCount = true; // Boolean | Total record count. Boolean enableTotalRecordCount = true; // Boolean | Total record count.
@ -97,7 +97,7 @@ public class Example {
| **includeItemTypes** | [**List&lt;BaseItemKind&gt;**](BaseItemKind.md)| Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. | [optional] | | **includeItemTypes** | [**List&lt;BaseItemKind&gt;**](BaseItemKind.md)| Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. | [optional] |
| **filters** | [**List&lt;ItemFilter&gt;**](ItemFilter.md)| Optional. Specify additional filters to apply. | [optional] | | **filters** | [**List&lt;ItemFilter&gt;**](ItemFilter.md)| Optional. Specify additional filters to apply. | [optional] |
| **isFavorite** | **Boolean**| Optional filter by items that are marked as favorite, or not. | [optional] | | **isFavorite** | **Boolean**| Optional filter by items that are marked as favorite, or not. | [optional] |
| **mediaTypes** | [**List&lt;String&gt;**](String.md)| Optional filter by MediaType. Allows multiple, comma delimited. | [optional] | | **mediaTypes** | [**List&lt;MediaType&gt;**](MediaType.md)| Optional filter by MediaType. Allows multiple, comma delimited. | [optional] |
| **genres** | [**List&lt;String&gt;**](String.md)| Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. | [optional] | | **genres** | [**List&lt;String&gt;**](String.md)| Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. | [optional] |
| **genreIds** | [**List&lt;UUID&gt;**](UUID.md)| Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. | [optional] | | **genreIds** | [**List&lt;UUID&gt;**](UUID.md)| Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. | [optional] |
| **officialRatings** | [**List&lt;String&gt;**](String.md)| Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. | [optional] | | **officialRatings** | [**List&lt;String&gt;**](String.md)| Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. | [optional] |
@ -115,7 +115,7 @@ public class Example {
| **nameStartsWithOrGreater** | **String**| Optional filter by items whose name is sorted equally or greater than a given input string. | [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] | | **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] | | **nameLessThan** | **String**| Optional filter by items whose name is equally or lesser than a given input string. | [optional] |
| **sortBy** | [**List&lt;String&gt;**](String.md)| Optional. Specify one or more sort orders, comma delimited. | [optional] | | **sortBy** | [**List&lt;ItemSortBy&gt;**](ItemSortBy.md)| Optional. Specify one or more sort orders, comma delimited. | [optional] |
| **sortOrder** | [**List&lt;SortOrder&gt;**](SortOrder.md)| Sort Order - Ascending,Descending. | [optional] | | **sortOrder** | [**List&lt;SortOrder&gt;**](SortOrder.md)| Sort Order - Ascending,Descending. | [optional] |
| **enableImages** | **Boolean**| Optional, include image information in output. | [optional] [default to true] | | **enableImages** | **Boolean**| Optional, include image information in output. | [optional] [default to true] |
| **enableTotalRecordCount** | **Boolean**| Total record count. | [optional] [default to true] | | **enableTotalRecordCount** | **Boolean**| Total record count. | [optional] [default to true] |
@ -159,7 +159,7 @@ import org.openapitools.client.api.ArtistsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -230,7 +230,7 @@ import org.openapitools.client.api.ArtistsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -249,7 +249,7 @@ public class Example {
List<BaseItemKind> includeItemTypes = Arrays.asList(); // List<BaseItemKind> | Optional. If specified, results will be filtered 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. 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. 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<MediaType> mediaTypes = Arrays.asList(); // List<MediaType> | 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<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<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> officialRatings = Arrays.asList(); // List<String> | Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
@ -267,7 +267,7 @@ public class Example {
String nameStartsWithOrGreater = "nameStartsWithOrGreater_example"; // String | Optional filter by items whose name is sorted equally or greater than a given input string. 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 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. 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<ItemSortBy> sortBy = Arrays.asList(); // List<ItemSortBy> | Optional. Specify one or more sort orders, comma delimited.
List<SortOrder> sortOrder = Arrays.asList(); // List<SortOrder> | Sort Order - Ascending,Descending. List<SortOrder> sortOrder = Arrays.asList(); // List<SortOrder> | Sort Order - Ascending,Descending.
Boolean enableImages = true; // Boolean | Optional, include image information in output. Boolean enableImages = true; // Boolean | Optional, include image information in output.
Boolean enableTotalRecordCount = true; // Boolean | Total record count. Boolean enableTotalRecordCount = true; // Boolean | Total record count.
@ -299,7 +299,7 @@ public class Example {
| **includeItemTypes** | [**List&lt;BaseItemKind&gt;**](BaseItemKind.md)| Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. | [optional] | | **includeItemTypes** | [**List&lt;BaseItemKind&gt;**](BaseItemKind.md)| Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. | [optional] |
| **filters** | [**List&lt;ItemFilter&gt;**](ItemFilter.md)| Optional. Specify additional filters to apply. | [optional] | | **filters** | [**List&lt;ItemFilter&gt;**](ItemFilter.md)| Optional. Specify additional filters to apply. | [optional] |
| **isFavorite** | **Boolean**| Optional filter by items that are marked as favorite, or not. | [optional] | | **isFavorite** | **Boolean**| Optional filter by items that are marked as favorite, or not. | [optional] |
| **mediaTypes** | [**List&lt;String&gt;**](String.md)| Optional filter by MediaType. Allows multiple, comma delimited. | [optional] | | **mediaTypes** | [**List&lt;MediaType&gt;**](MediaType.md)| Optional filter by MediaType. Allows multiple, comma delimited. | [optional] |
| **genres** | [**List&lt;String&gt;**](String.md)| Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. | [optional] | | **genres** | [**List&lt;String&gt;**](String.md)| Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. | [optional] |
| **genreIds** | [**List&lt;UUID&gt;**](UUID.md)| Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. | [optional] | | **genreIds** | [**List&lt;UUID&gt;**](UUID.md)| Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. | [optional] |
| **officialRatings** | [**List&lt;String&gt;**](String.md)| Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. | [optional] | | **officialRatings** | [**List&lt;String&gt;**](String.md)| Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. | [optional] |
@ -317,7 +317,7 @@ public class Example {
| **nameStartsWithOrGreater** | **String**| Optional filter by items whose name is sorted equally or greater than a given input string. | [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] | | **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] | | **nameLessThan** | **String**| Optional filter by items whose name is equally or lesser than a given input string. | [optional] |
| **sortBy** | [**List&lt;String&gt;**](String.md)| Optional. Specify one or more sort orders, comma delimited. | [optional] | | **sortBy** | [**List&lt;ItemSortBy&gt;**](ItemSortBy.md)| Optional. Specify one or more sort orders, comma delimited. | [optional] |
| **sortOrder** | [**List&lt;SortOrder&gt;**](SortOrder.md)| Sort Order - Ascending,Descending. | [optional] | | **sortOrder** | [**List&lt;SortOrder&gt;**](SortOrder.md)| Sort Order - Ascending,Descending. | [optional] |
| **enableImages** | **Boolean**| Optional, include image information in output. | [optional] [default to true] | | **enableImages** | **Boolean**| Optional, include image information in output. | [optional] [default to true] |
| **enableTotalRecordCount** | **Boolean**| Total record count. | [optional] [default to true] | | **enableTotalRecordCount** | **Boolean**| Total record count. | [optional] [default to true] |

View File

@ -1,6 +1,6 @@
# AudioApi # AudioApi
All URIs are relative to *http://nuc.ehrendingen:8096* All URIs are relative to *http://localhost*
| Method | HTTP request | Description | | Method | HTTP request | Description |
|------------- | ------------- | -------------| |------------- | ------------- | -------------|
@ -12,7 +12,7 @@ All URIs are relative to *http://nuc.ehrendingen:8096*
<a id="getAudioStream"></a> <a id="getAudioStream"></a>
# **getAudioStream** # **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) > File getAudioStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding)
Gets an audio stream. Gets an audio stream.
@ -28,7 +28,7 @@ import org.openapitools.client.api.AudioApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
AudioApi apiInstance = new AudioApi(defaultClient); AudioApi apiInstance = new AudioApi(defaultClient);
UUID itemId = UUID.randomUUID(); // UUID | The item id. UUID itemId = UUID.randomUUID(); // UUID | The item id.
@ -43,7 +43,7 @@ public class Example {
Integer minSegments = 56; // Integer | The minimum number of segments. Integer minSegments = 56; // Integer | The minimum number of segments.
String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. 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 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. String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension.
Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. Boolean 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 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 allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url.
@ -73,15 +73,16 @@ public class Example {
Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use.
String liveStreamId = "liveStreamId_example"; // String | The live stream id. String liveStreamId = "liveStreamId_example"; // String | The live stream id.
Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. 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 videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension.
String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to.
String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. 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 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. 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. 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. Map<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding.
try { 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); File result = apiInstance.getAudioStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling AudioApi#getAudioStream"); System.err.println("Exception when calling AudioApi#getAudioStream");
@ -110,7 +111,7 @@ public class Example {
| **minSegments** | **Integer**| The minimum number of segments. | [optional] | | **minSegments** | **Integer**| The minimum number of segments. | [optional] |
| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [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] | | **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&#39;s extension. Options: aac, mp3, vorbis, wma. | [optional] | | **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url&#39;s extension. | [optional] |
| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [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] | | **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] | | **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] |
@ -130,7 +131,7 @@ public class Example {
| **height** | **Integer**| Optional. The fixed vertical 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] | | **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] | | **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] | | **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] |
| **maxRefFrames** | **Integer**| Optional. | [optional] | | **maxRefFrames** | **Integer**| Optional. | [optional] |
| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | | **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] |
| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | | **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] |
@ -140,13 +141,14 @@ public class Example {
| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | | **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] |
| **liveStreamId** | **String**| The live stream id. | [optional] | | **liveStreamId** | **String**| The live stream id. | [optional] |
| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [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&#39;s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. | [optional] | | **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url&#39;s extension. | [optional] |
| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | | **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] |
| **transcodeReasons** | **String**| Optional. The transcoding reason. | [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] | | **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] | | **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] | | **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
| **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] | | **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] |
| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] |
### Return type ### Return type
@ -168,7 +170,7 @@ No authorization required
<a id="getAudioStreamByContainer"></a> <a id="getAudioStreamByContainer"></a>
# **getAudioStreamByContainer** # **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) > File getAudioStreamByContainer(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding)
Gets an audio stream. Gets an audio stream.
@ -184,7 +186,7 @@ import org.openapitools.client.api.AudioApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
AudioApi apiInstance = new AudioApi(defaultClient); AudioApi apiInstance = new AudioApi(defaultClient);
UUID itemId = UUID.randomUUID(); // UUID | The item id. UUID itemId = UUID.randomUUID(); // UUID | The item id.
@ -195,11 +197,11 @@ public class Example {
String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize.
String playSessionId = "playSessionId_example"; // String | The play session id. String playSessionId = "playSessionId_example"; // String | The play session id.
String segmentContainer = "segmentContainer_example"; // String | The segment container. String segmentContainer = "segmentContainer_example"; // String | The segment container.
Integer segmentLength = 56; // Integer | The segment lenght. Integer segmentLength = 56; // Integer | The segment length.
Integer minSegments = 56; // Integer | The minimum number of segments. Integer minSegments = 56; // Integer | The minimum number of segments.
String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. 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 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. String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension.
Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. Boolean 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 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 allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url.
@ -229,15 +231,16 @@ public class Example {
Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use.
String liveStreamId = "liveStreamId_example"; // String | The live stream id. String liveStreamId = "liveStreamId_example"; // String | The live stream id.
Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. 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 videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension.
String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to.
String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. 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 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. 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. 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. Map<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding.
try { 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); File result = apiInstance.getAudioStreamByContainer(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling AudioApi#getAudioStreamByContainer"); System.err.println("Exception when calling AudioApi#getAudioStreamByContainer");
@ -262,11 +265,11 @@ public class Example {
| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | | **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] |
| **playSessionId** | **String**| The play session id. | [optional] | | **playSessionId** | **String**| The play session id. | [optional] |
| **segmentContainer** | **String**| The segment container. | [optional] | | **segmentContainer** | **String**| The segment container. | [optional] |
| **segmentLength** | **Integer**| The segment lenght. | [optional] | | **segmentLength** | **Integer**| The segment length. | [optional] |
| **minSegments** | **Integer**| The minimum number of segments. | [optional] | | **minSegments** | **Integer**| The minimum number of segments. | [optional] |
| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [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] | | **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&#39;s extension. Options: aac, mp3, vorbis, wma. | [optional] | | **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url&#39;s extension. | [optional] |
| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [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] | | **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] | | **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] |
@ -286,7 +289,7 @@ public class Example {
| **height** | **Integer**| Optional. The fixed vertical 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] | | **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] | | **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] | | **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] |
| **maxRefFrames** | **Integer**| Optional. | [optional] | | **maxRefFrames** | **Integer**| Optional. | [optional] |
| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | | **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] |
| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | | **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] |
@ -296,13 +299,14 @@ public class Example {
| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | | **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] |
| **liveStreamId** | **String**| The live stream id. | [optional] | | **liveStreamId** | **String**| The live stream id. | [optional] |
| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [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&#39;s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. | [optional] | | **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url&#39;s extension. | [optional] |
| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | | **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] |
| **transcodeReasons** | **String**| Optional. The transcoding reason. | [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] | | **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] | | **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] | | **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
| **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] | | **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] |
| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] |
### Return type ### Return type
@ -324,7 +328,7 @@ No authorization required
<a id="headAudioStream"></a> <a id="headAudioStream"></a>
# **headAudioStream** # **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) > File headAudioStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding)
Gets an audio stream. Gets an audio stream.
@ -340,7 +344,7 @@ import org.openapitools.client.api.AudioApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
AudioApi apiInstance = new AudioApi(defaultClient); AudioApi apiInstance = new AudioApi(defaultClient);
UUID itemId = UUID.randomUUID(); // UUID | The item id. UUID itemId = UUID.randomUUID(); // UUID | The item id.
@ -355,7 +359,7 @@ public class Example {
Integer minSegments = 56; // Integer | The minimum number of segments. Integer minSegments = 56; // Integer | The minimum number of segments.
String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. 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 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. String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension.
Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. Boolean 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 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 allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url.
@ -385,15 +389,16 @@ public class Example {
Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use.
String liveStreamId = "liveStreamId_example"; // String | The live stream id. String liveStreamId = "liveStreamId_example"; // String | The live stream id.
Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. 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 videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension.
String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to.
String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. 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 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. 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. 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. Map<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding.
try { 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); File result = apiInstance.headAudioStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling AudioApi#headAudioStream"); System.err.println("Exception when calling AudioApi#headAudioStream");
@ -422,7 +427,7 @@ public class Example {
| **minSegments** | **Integer**| The minimum number of segments. | [optional] | | **minSegments** | **Integer**| The minimum number of segments. | [optional] |
| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [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] | | **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&#39;s extension. Options: aac, mp3, vorbis, wma. | [optional] | | **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url&#39;s extension. | [optional] |
| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [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] | | **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] | | **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] |
@ -442,7 +447,7 @@ public class Example {
| **height** | **Integer**| Optional. The fixed vertical 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] | | **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] | | **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] | | **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] |
| **maxRefFrames** | **Integer**| Optional. | [optional] | | **maxRefFrames** | **Integer**| Optional. | [optional] |
| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | | **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] |
| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | | **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] |
@ -452,13 +457,14 @@ public class Example {
| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | | **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] |
| **liveStreamId** | **String**| The live stream id. | [optional] | | **liveStreamId** | **String**| The live stream id. | [optional] |
| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [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&#39;s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. | [optional] | | **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url&#39;s extension. | [optional] |
| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | | **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] |
| **transcodeReasons** | **String**| Optional. The transcoding reason. | [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] | | **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] | | **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] | | **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
| **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] | | **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] |
| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] |
### Return type ### Return type
@ -480,7 +486,7 @@ No authorization required
<a id="headAudioStreamByContainer"></a> <a id="headAudioStreamByContainer"></a>
# **headAudioStreamByContainer** # **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) > File headAudioStreamByContainer(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding)
Gets an audio stream. Gets an audio stream.
@ -496,7 +502,7 @@ import org.openapitools.client.api.AudioApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
AudioApi apiInstance = new AudioApi(defaultClient); AudioApi apiInstance = new AudioApi(defaultClient);
UUID itemId = UUID.randomUUID(); // UUID | The item id. UUID itemId = UUID.randomUUID(); // UUID | The item id.
@ -507,11 +513,11 @@ public class Example {
String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize.
String playSessionId = "playSessionId_example"; // String | The play session id. String playSessionId = "playSessionId_example"; // String | The play session id.
String segmentContainer = "segmentContainer_example"; // String | The segment container. String segmentContainer = "segmentContainer_example"; // String | The segment container.
Integer segmentLength = 56; // Integer | The segment lenght. Integer segmentLength = 56; // Integer | The segment length.
Integer minSegments = 56; // Integer | The minimum number of segments. Integer minSegments = 56; // Integer | The minimum number of segments.
String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. 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 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. String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension.
Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. Boolean 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 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 allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url.
@ -541,15 +547,16 @@ public class Example {
Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use.
String liveStreamId = "liveStreamId_example"; // String | The live stream id. String liveStreamId = "liveStreamId_example"; // String | The live stream id.
Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. 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 videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension.
String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to.
String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. 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 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. 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. 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. Map<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding.
try { 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); File result = apiInstance.headAudioStreamByContainer(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling AudioApi#headAudioStreamByContainer"); System.err.println("Exception when calling AudioApi#headAudioStreamByContainer");
@ -574,11 +581,11 @@ public class Example {
| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | | **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] |
| **playSessionId** | **String**| The play session id. | [optional] | | **playSessionId** | **String**| The play session id. | [optional] |
| **segmentContainer** | **String**| The segment container. | [optional] | | **segmentContainer** | **String**| The segment container. | [optional] |
| **segmentLength** | **Integer**| The segment lenght. | [optional] | | **segmentLength** | **Integer**| The segment length. | [optional] |
| **minSegments** | **Integer**| The minimum number of segments. | [optional] | | **minSegments** | **Integer**| The minimum number of segments. | [optional] |
| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [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] | | **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&#39;s extension. Options: aac, mp3, vorbis, wma. | [optional] | | **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url&#39;s extension. | [optional] |
| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [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] | | **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] | | **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] |
@ -598,7 +605,7 @@ public class Example {
| **height** | **Integer**| Optional. The fixed vertical 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] | | **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] | | **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] | | **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] |
| **maxRefFrames** | **Integer**| Optional. | [optional] | | **maxRefFrames** | **Integer**| Optional. | [optional] |
| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | | **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] |
| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | | **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] |
@ -608,13 +615,14 @@ public class Example {
| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | | **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] |
| **liveStreamId** | **String**| The live stream id. | [optional] | | **liveStreamId** | **String**| The live stream id. | [optional] |
| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [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&#39;s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. | [optional] | | **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url&#39;s extension. | [optional] |
| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | | **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] |
| **transcodeReasons** | **String**| Optional. The transcoding reason. | [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] | | **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] | | **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] | | **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
| **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] | | **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] |
| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] |
### Return type ### Return type

View File

@ -0,0 +1,15 @@
# AudioSpatialFormat
## Enum
* `NONE` (value: `"None"`)
* `DOLBY_ATMOS` (value: `"DolbyAtmos"`)
* `DTSX` (value: `"DTSX"`)

View File

@ -10,7 +10,6 @@ The authenticate user by name request body.
|------------ | ------------- | ------------- | -------------| |------------ | ------------- | ------------- | -------------|
|**username** | **String** | Gets or sets the username. | [optional] | |**username** | **String** | Gets or sets the username. | [optional] |
|**pw** | **String** | Gets or sets the plain text password. | [optional] | |**pw** | **String** | Gets or sets the plain text password. | [optional] |
|**password** | **String** | Gets or sets the sha1-hashed password. | [optional] |

View File

@ -0,0 +1,17 @@
# AuthenticationResult
A class representing an authentication result.
## Properties
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**user** | [**UserDto**](UserDto.md) | Class UserDto. | [optional] |
|**sessionInfo** | [**SessionInfoDto**](SessionInfoDto.md) | Session info DTO. | [optional] |
|**accessToken** | **String** | Gets or sets the access token. | [optional] |
|**serverId** | **String** | Gets or sets the server id. | [optional] |

View File

@ -17,16 +17,16 @@ This is strictly used as a data transfer object from the api layer. This holds
|**playlistItemId** | **String** | Gets or sets the playlist item identifier. | [optional] | |**playlistItemId** | **String** | Gets or sets the playlist item identifier. | [optional] |
|**dateCreated** | **OffsetDateTime** | Gets or sets the date created. | [optional] | |**dateCreated** | **OffsetDateTime** | Gets or sets the date created. | [optional] |
|**dateLastMediaAdded** | **OffsetDateTime** | | [optional] | |**dateLastMediaAdded** | **OffsetDateTime** | | [optional] |
|**extraType** | **String** | | [optional] | |**extraType** | **ExtraType** | | [optional] |
|**airsBeforeSeasonNumber** | **Integer** | | [optional] | |**airsBeforeSeasonNumber** | **Integer** | | [optional] |
|**airsAfterSeasonNumber** | **Integer** | | [optional] | |**airsAfterSeasonNumber** | **Integer** | | [optional] |
|**airsBeforeEpisodeNumber** | **Integer** | | [optional] | |**airsBeforeEpisodeNumber** | **Integer** | | [optional] |
|**canDelete** | **Boolean** | | [optional] | |**canDelete** | **Boolean** | | [optional] |
|**canDownload** | **Boolean** | | [optional] | |**canDownload** | **Boolean** | | [optional] |
|**hasLyrics** | **Boolean** | | [optional] |
|**hasSubtitles** | **Boolean** | | [optional] | |**hasSubtitles** | **Boolean** | | [optional] |
|**preferredMetadataLanguage** | **String** | | [optional] | |**preferredMetadataLanguage** | **String** | | [optional] |
|**preferredMetadataCountryCode** | **String** | | [optional] | |**preferredMetadataCountryCode** | **String** | | [optional] |
|**supportsSync** | **Boolean** | Gets or sets a value indicating whether [supports synchronize]. | [optional] |
|**container** | **String** | | [optional] | |**container** | **String** | | [optional] |
|**sortName** | **String** | Gets or sets the name of the sort. | [optional] | |**sortName** | **String** | Gets or sets the name of the sort. | [optional] |
|**forcedSortName** | **String** | | [optional] | |**forcedSortName** | **String** | | [optional] |
@ -62,12 +62,12 @@ This is strictly used as a data transfer object from the api layer. This holds
|**isHD** | **Boolean** | Gets or sets a value indicating whether this instance is HD. | [optional] | |**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] | |**isFolder** | **Boolean** | Gets or sets a value indicating whether this instance is folder. | [optional] |
|**parentId** | **UUID** | Gets or sets the parent id. | [optional] | |**parentId** | **UUID** | Gets or sets the parent id. | [optional] |
|**type** | **BaseItemKind** | Gets or sets the type. | [optional] | |**type** | **BaseItemKind** | The base item kind. | [optional] |
|**people** | [**List&lt;BaseItemPerson&gt;**](BaseItemPerson.md) | Gets or sets the people. | [optional] | |**people** | [**List&lt;BaseItemPerson&gt;**](BaseItemPerson.md) | Gets or sets the people. | [optional] |
|**studios** | [**List&lt;NameGuidPair&gt;**](NameGuidPair.md) | Gets or sets the studios. | [optional] | |**studios** | [**List&lt;NameGuidPair&gt;**](NameGuidPair.md) | Gets or sets the studios. | [optional] |
|**genreItems** | [**List&lt;NameGuidPair&gt;**](NameGuidPair.md) | | [optional] | |**genreItems** | [**List&lt;NameGuidPair&gt;**](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] | |**parentLogoItemId** | **UUID** | Gets or sets whether the item has a logo, this will hold the Id of the Parent that has one. | [optional] |
|**parentBackdropItemId** | **UUID** | Gets or sets wether the item has any backdrops, this will hold the Id of the Parent that has one. | [optional] | |**parentBackdropItemId** | **UUID** | Gets or sets whether the item has any backdrops, this will hold the Id of the Parent that has one. | [optional] |
|**parentBackdropImageTags** | **List&lt;String&gt;** | Gets or sets the parent backdrop image tags. | [optional] | |**parentBackdropImageTags** | **List&lt;String&gt;** | Gets or sets the parent backdrop image tags. | [optional] |
|**localTrailerCount** | **Integer** | Gets or sets the local trailer count. | [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&#39;s being requested for. | [optional] | |**userData** | [**UserItemDataDto**](UserItemDataDto.md) | Gets or sets the user data for this item based on the user it&#39;s being requested for. | [optional] |
@ -86,7 +86,7 @@ This is strictly used as a data transfer object from the api layer. This holds
|**artists** | **List&lt;String&gt;** | Gets or sets the artists. | [optional] | |**artists** | **List&lt;String&gt;** | Gets or sets the artists. | [optional] |
|**artistItems** | [**List&lt;NameGuidPair&gt;**](NameGuidPair.md) | Gets or sets the artist items. | [optional] | |**artistItems** | [**List&lt;NameGuidPair&gt;**](NameGuidPair.md) | Gets or sets the artist items. | [optional] |
|**album** | **String** | Gets or sets the album. | [optional] | |**album** | **String** | Gets or sets the album. | [optional] |
|**collectionType** | **String** | Gets or sets the type of the collection. | [optional] | |**collectionType** | **CollectionType** | Gets or sets the type of the collection. | [optional] |
|**displayOrder** | **String** | Gets or sets the display order. | [optional] | |**displayOrder** | **String** | Gets or sets the display order. | [optional] |
|**albumId** | **UUID** | Gets or sets the album id. | [optional] | |**albumId** | **UUID** | Gets or sets the album id. | [optional] |
|**albumPrimaryImageTag** | **String** | Gets or sets the album image tag. | [optional] | |**albumPrimaryImageTag** | **String** | Gets or sets the album image tag. | [optional] |
@ -102,7 +102,7 @@ This is strictly used as a data transfer object from the api layer. This holds
|**backdropImageTags** | **List&lt;String&gt;** | Gets or sets the backdrop image tags. | [optional] | |**backdropImageTags** | **List&lt;String&gt;** | Gets or sets the backdrop image tags. | [optional] |
|**screenshotImageTags** | **List&lt;String&gt;** | Gets or sets the screenshot image tags. | [optional] | |**screenshotImageTags** | **List&lt;String&gt;** | Gets or sets the screenshot image tags. | [optional] |
|**parentLogoImageTag** | **String** | Gets or sets the parent logo image tag. | [optional] | |**parentLogoImageTag** | **String** | Gets or sets the parent logo image tag. | [optional] |
|**parentArtItemId** | **UUID** | Gets or sets wether the item has fan art, this will hold the Id of the Parent that has one. | [optional] | |**parentArtItemId** | **UUID** | Gets or sets whether the item has fan art, this will hold the Id of the Parent that has one. | [optional] |
|**parentArtImageTag** | **String** | Gets or sets the parent art image tag. | [optional] | |**parentArtImageTag** | **String** | Gets or sets the parent art image tag. | [optional] |
|**seriesThumbImageTag** | **String** | Gets or sets the series thumb image tag. | [optional] | |**seriesThumbImageTag** | **String** | Gets or sets the series thumb image tag. | [optional] |
|**imageBlurHashes** | [**BaseItemDtoImageBlurHashes**](BaseItemDtoImageBlurHashes.md) | | [optional] | |**imageBlurHashes** | [**BaseItemDtoImageBlurHashes**](BaseItemDtoImageBlurHashes.md) | | [optional] |
@ -112,9 +112,10 @@ This is strictly used as a data transfer object from the api layer. This holds
|**parentPrimaryImageItemId** | **String** | Gets or sets the parent primary image item identifier. | [optional] | |**parentPrimaryImageItemId** | **String** | Gets or sets the parent primary image item identifier. | [optional] |
|**parentPrimaryImageTag** | **String** | Gets or sets the parent primary image tag. | [optional] | |**parentPrimaryImageTag** | **String** | Gets or sets the parent primary image tag. | [optional] |
|**chapters** | [**List&lt;ChapterInfo&gt;**](ChapterInfo.md) | Gets or sets the chapters. | [optional] | |**chapters** | [**List&lt;ChapterInfo&gt;**](ChapterInfo.md) | Gets or sets the chapters. | [optional] |
|**trickplay** | **Map&lt;String, Map&lt;String, TrickplayInfo&gt;&gt;** | Gets or sets the trickplay manifest. | [optional] |
|**locationType** | **LocationType** | Gets or sets the type of the location. | [optional] | |**locationType** | **LocationType** | Gets or sets the type of the location. | [optional] |
|**isoType** | **IsoType** | Gets or sets the type of the iso. | [optional] | |**isoType** | **IsoType** | Gets or sets the type of the iso. | [optional] |
|**mediaType** | **String** | Gets or sets the type of the media. | [optional] | |**mediaType** | **MediaType** | Media types. | [optional] |
|**endDate** | **OffsetDateTime** | Gets or sets the end date. | [optional] | |**endDate** | **OffsetDateTime** | Gets or sets the end date. | [optional] |
|**lockedFields** | **List&lt;MetadataField&gt;** | Gets or sets the locked fields. | [optional] | |**lockedFields** | **List&lt;MetadataField&gt;** | Gets or sets the locked fields. | [optional] |
|**trailerCount** | **Integer** | Gets or sets the trailer count. | [optional] | |**trailerCount** | **Integer** | Gets or sets the trailer count. | [optional] |
@ -158,6 +159,7 @@ This is strictly used as a data transfer object from the api layer. This holds
|**isKids** | **Boolean** | Gets or sets a value indicating whether this instance is kids. | [optional] | |**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] | |**isPremiere** | **Boolean** | Gets or sets a value indicating whether this instance is premiere. | [optional] |
|**timerId** | **String** | Gets or sets the timer identifier. | [optional] | |**timerId** | **String** | Gets or sets the timer identifier. | [optional] |
|**normalizationGain** | **Float** | Gets or sets the gain required for audio normalization. | [optional] |
|**currentProgram** | [**BaseItemDto**](BaseItemDto.md) | Gets or sets the current program. | [optional] | |**currentProgram** | [**BaseItemDto**](BaseItemDto.md) | Gets or sets the current program. | [optional] |

View File

@ -11,7 +11,7 @@ This is used by the api to get information about a Person within a BaseItem.
|**name** | **String** | Gets or sets the name. | [optional] | |**name** | **String** | Gets or sets the name. | [optional] |
|**id** | **UUID** | Gets or sets the identifier. | [optional] | |**id** | **UUID** | Gets or sets the identifier. | [optional] |
|**role** | **String** | Gets or sets the role. | [optional] | |**role** | **String** | Gets or sets the role. | [optional] |
|**type** | **String** | Gets or sets the type. | [optional] | |**type** | **PersonKind** | The person kind. | [optional] |
|**primaryImageTag** | **String** | Gets or sets the primary image tag. | [optional] | |**primaryImageTag** | **String** | Gets or sets the primary image tag. | [optional] |
|**imageBlurHashes** | [**BaseItemPersonImageBlurHashes**](BaseItemPersonImageBlurHashes.md) | | [optional] | |**imageBlurHashes** | [**BaseItemPersonImageBlurHashes**](BaseItemPersonImageBlurHashes.md) | | [optional] |

View File

@ -1,6 +1,6 @@
# BrandingApi # BrandingApi
All URIs are relative to *http://nuc.ehrendingen:8096* All URIs are relative to *http://localhost*
| Method | HTTP request | Description | | Method | HTTP request | Description |
|------------- | ------------- | -------------| |------------- | ------------- | -------------|
@ -27,7 +27,7 @@ import org.openapitools.client.api.BrandingApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
BrandingApi apiInstance = new BrandingApi(defaultClient); BrandingApi apiInstance = new BrandingApi(defaultClient);
try { try {
@ -84,7 +84,7 @@ import org.openapitools.client.api.BrandingApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
BrandingApi apiInstance = new BrandingApi(defaultClient); BrandingApi apiInstance = new BrandingApi(defaultClient);
try { try {
@ -141,7 +141,7 @@ import org.openapitools.client.api.BrandingApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
BrandingApi apiInstance = new BrandingApi(defaultClient); BrandingApi apiInstance = new BrandingApi(defaultClient);
try { try {

View File

@ -0,0 +1,15 @@
# CastReceiverApplication
The cast receiver application model.
## Properties
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | Gets or sets the cast receiver application id. | [optional] |
|**name** | **String** | Gets or sets the cast receiver application name. | [optional] |

View File

@ -1,6 +1,6 @@
# ChannelsApi # ChannelsApi
All URIs are relative to *http://nuc.ehrendingen:8096* All URIs are relative to *http://localhost*
| Method | HTTP request | Description | | Method | HTTP request | Description |
|------------- | ------------- | -------------| |------------- | ------------- | -------------|
@ -30,7 +30,7 @@ import org.openapitools.client.api.ChannelsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -95,7 +95,7 @@ import org.openapitools.client.api.ChannelsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -164,7 +164,7 @@ import org.openapitools.client.api.ChannelsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -180,7 +180,7 @@ public class Example {
Integer limit = 56; // Integer | Optional. The maximum number of records to return. 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<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<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<ItemSortBy> sortBy = Arrays.asList(); // List<ItemSortBy> | Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
List<ItemFields> fields = Arrays.asList(); // List<ItemFields> | Optional. Specify additional fields of information to return in the output. List<ItemFields> fields = Arrays.asList(); // List<ItemFields> | Optional. Specify additional fields of information to return in the output.
try { try {
BaseItemDtoQueryResult result = apiInstance.getChannelItems(channelId, folderId, userId, startIndex, limit, sortOrder, filters, sortBy, fields); BaseItemDtoQueryResult result = apiInstance.getChannelItems(channelId, folderId, userId, startIndex, limit, sortOrder, filters, sortBy, fields);
@ -207,7 +207,7 @@ public class Example {
| **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] | | **limit** | **Integer**| Optional. The maximum number of records to return. | [optional] |
| **sortOrder** | [**List&lt;SortOrder&gt;**](SortOrder.md)| Optional. Sort Order - Ascending,Descending. | [optional] | | **sortOrder** | [**List&lt;SortOrder&gt;**](SortOrder.md)| Optional. Sort Order - Ascending,Descending. | [optional] |
| **filters** | [**List&lt;ItemFilter&gt;**](ItemFilter.md)| Optional. Specify additional filters to apply. | [optional] | | **filters** | [**List&lt;ItemFilter&gt;**](ItemFilter.md)| Optional. Specify additional filters to apply. | [optional] |
| **sortBy** | [**List&lt;String&gt;**](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] | | **sortBy** | [**List&lt;ItemSortBy&gt;**](ItemSortBy.md)| Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. | [optional] |
| **fields** | [**List&lt;ItemFields&gt;**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] | | **fields** | [**List&lt;ItemFields&gt;**](ItemFields.md)| Optional. Specify additional fields of information to return in the output. | [optional] |
### Return type ### Return type
@ -249,7 +249,7 @@ import org.openapitools.client.api.ChannelsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -328,7 +328,7 @@ import org.openapitools.client.api.ChannelsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");

View File

@ -8,13 +8,10 @@ Client capabilities dto.
| Name | Type | Description | Notes | | Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------| |------------ | ------------- | ------------- | -------------|
|**playableMediaTypes** | **List&lt;String&gt;** | Gets or sets the list of playable media types. | [optional] | |**playableMediaTypes** | **List&lt;MediaType&gt;** | Gets or sets the list of playable media types. | [optional] |
|**supportedCommands** | **List&lt;GeneralCommandType&gt;** | Gets or sets the list of supported commands. | [optional] | |**supportedCommands** | **List&lt;GeneralCommandType&gt;** | Gets or sets the list of supported commands. | [optional] |
|**supportsMediaControl** | **Boolean** | Gets or sets a value indicating whether session supports media control. | [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] | |**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] | |**deviceProfile** | [**DeviceProfile**](DeviceProfile.md) | Gets or sets the device profile. | [optional] |
|**appStoreUrl** | **String** | Gets or sets the app store url. | [optional] | |**appStoreUrl** | **String** | Gets or sets the app store url. | [optional] |
|**iconUrl** | **String** | Gets or sets the icon url. | [optional] | |**iconUrl** | **String** | Gets or sets the icon url. | [optional] |

View File

@ -1,6 +1,6 @@
# ClientLogApi # ClientLogApi
All URIs are relative to *http://nuc.ehrendingen:8096* All URIs are relative to *http://localhost*
| Method | HTTP request | Description | | Method | HTTP request | Description |
|------------- | ------------- | -------------| |------------- | ------------- | -------------|
@ -26,7 +26,7 @@ import org.openapitools.client.api.ClientLogApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");

View File

@ -0,0 +1,19 @@
# CodecProfile
Defines the MediaBrowser.Model.Dlna.CodecProfile.
## Properties
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**type** | **CodecType** | Gets or sets the MediaBrowser.Model.Dlna.CodecType which this container must meet. | [optional] |
|**conditions** | [**List&lt;ProfileCondition&gt;**](ProfileCondition.md) | Gets or sets the list of MediaBrowser.Model.Dlna.ProfileCondition which this profile must meet. | [optional] |
|**applyConditions** | [**List&lt;ProfileCondition&gt;**](ProfileCondition.md) | Gets or sets the list of MediaBrowser.Model.Dlna.ProfileCondition to apply if this profile is met. | [optional] |
|**codec** | **String** | Gets or sets the codec(s) that this profile applies to. | [optional] |
|**container** | **String** | Gets or sets the container(s) which this profile will be applied to. | [optional] |
|**subContainer** | **String** | Gets or sets the sub-container(s) which this profile will be applied to. | [optional] |

View File

@ -1,6 +1,6 @@
# CollectionApi # CollectionApi
All URIs are relative to *http://nuc.ehrendingen:8096* All URIs are relative to *http://localhost*
| Method | HTTP request | Description | | Method | HTTP request | Description |
|------------- | ------------- | -------------| |------------- | ------------- | -------------|
@ -28,7 +28,7 @@ import org.openapitools.client.api.CollectionApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -98,7 +98,7 @@ import org.openapitools.client.api.CollectionApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -173,7 +173,7 @@ import org.openapitools.client.api.CollectionApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");

View File

@ -0,0 +1,35 @@
# CollectionType
## Enum
* `UNKNOWN` (value: `"unknown"`)
* `MOVIES` (value: `"movies"`)
* `TVSHOWS` (value: `"tvshows"`)
* `MUSIC` (value: `"music"`)
* `MUSICVIDEOS` (value: `"musicvideos"`)
* `TRAILERS` (value: `"trailers"`)
* `HOMEVIDEOS` (value: `"homevideos"`)
* `BOXSETS` (value: `"boxsets"`)
* `BOOKS` (value: `"books"`)
* `PHOTOS` (value: `"photos"`)
* `LIVETV` (value: `"livetv"`)
* `PLAYLISTS` (value: `"playlists"`)
* `FOLDERS` (value: `"folders"`)

View File

@ -0,0 +1,25 @@
# CollectionTypeOptions
## Enum
* `MOVIES` (value: `"movies"`)
* `TVSHOWS` (value: `"tvshows"`)
* `MUSIC` (value: `"music"`)
* `MUSICVIDEOS` (value: `"musicvideos"`)
* `HOMEVIDEOS` (value: `"homevideos"`)
* `BOXSETS` (value: `"boxsets"`)
* `BOOKS` (value: `"books"`)
* `MIXED` (value: `"mixed"`)

View File

@ -1,6 +1,6 @@
# ConfigurationApi # ConfigurationApi
All URIs are relative to *http://nuc.ehrendingen:8096* All URIs are relative to *http://localhost*
| Method | HTTP request | Description | | Method | HTTP request | Description |
|------------- | ------------- | -------------| |------------- | ------------- | -------------|
@ -8,7 +8,6 @@ All URIs are relative to *http://nuc.ehrendingen:8096*
| [**getDefaultMetadataOptions**](ConfigurationApi.md#getDefaultMetadataOptions) | **GET** /System/Configuration/MetadataOptions/Default | Gets a default MetadataOptions object. | | [**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. | | [**getNamedConfiguration**](ConfigurationApi.md#getNamedConfiguration) | **GET** /System/Configuration/{key} | Gets a named configuration. |
| [**updateConfiguration**](ConfigurationApi.md#updateConfiguration) | **POST** /System/Configuration | Updates application 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. | | [**updateNamedConfiguration**](ConfigurationApi.md#updateNamedConfiguration) | **POST** /System/Configuration/{key} | Updates named configuration. |
@ -31,7 +30,7 @@ import org.openapitools.client.api.ConfigurationApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -96,7 +95,7 @@ import org.openapitools.client.api.ConfigurationApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -161,7 +160,7 @@ import org.openapitools.client.api.ConfigurationApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -230,7 +229,7 @@ import org.openapitools.client.api.ConfigurationApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -279,74 +278,6 @@ null (empty response body)
| **401** | Unauthorized | - | | **401** | Unauthorized | - |
| **403** | Forbidden | - | | **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> <a id="updateNamedConfiguration"></a>
# **updateNamedConfiguration** # **updateNamedConfiguration**
> updateNamedConfiguration(key, body) > updateNamedConfiguration(key, body)
@ -366,7 +297,7 @@ import org.openapitools.client.api.ConfigurationApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");

View File

@ -0,0 +1,17 @@
# ContainerProfile
Defines the MediaBrowser.Model.Dlna.ContainerProfile.
## Properties
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**type** | **DlnaProfileType** | Gets or sets the MediaBrowser.Model.Dlna.DlnaProfileType which this container must meet. | [optional] |
|**conditions** | [**List&lt;ProfileCondition&gt;**](ProfileCondition.md) | Gets or sets the list of MediaBrowser.Model.Dlna.ProfileCondition which this container will be applied to. | [optional] |
|**container** | **String** | Gets or sets the container(s) which this container must meet. | [optional] |
|**subContainer** | **String** | Gets or sets the sub container(s) which this container must meet. | [optional] |

View File

@ -11,7 +11,9 @@ Create new playlist dto.
|**name** | **String** | Gets or sets the name of the new playlist. | [optional] | |**name** | **String** | Gets or sets the name of the new playlist. | [optional] |
|**ids** | **List&lt;UUID&gt;** | Gets or sets item ids to add to the playlist. | [optional] | |**ids** | **List&lt;UUID&gt;** | Gets or sets item ids to add to the playlist. | [optional] |
|**userId** | **UUID** | Gets or sets the user id. | [optional] | |**userId** | **UUID** | Gets or sets the user id. | [optional] |
|**mediaType** | **String** | Gets or sets the media type. | [optional] | |**mediaType** | **MediaType** | Gets or sets the media type. | [optional] |
|**users** | [**List&lt;PlaylistUserPermissions&gt;**](PlaylistUserPermissions.md) | Gets or sets the playlist users. | [optional] |
|**isPublic** | **Boolean** | Gets or sets a value indicating whether the playlist is public. | [optional] |

View File

@ -8,7 +8,7 @@ The create user by name request body.
| Name | Type | Description | Notes | | Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------| |------------ | ------------- | ------------- | -------------|
|**name** | **String** | Gets or sets the username. | [optional] | |**name** | **String** | Gets or sets the username. | |
|**password** | **String** | Gets or sets the password. | [optional] | |**password** | **String** | Gets or sets the password. | [optional] |

View File

@ -1,6 +1,6 @@
# DashboardApi # DashboardApi
All URIs are relative to *http://nuc.ehrendingen:8096* All URIs are relative to *http://localhost*
| Method | HTTP request | Description | | Method | HTTP request | Description |
|------------- | ------------- | -------------| |------------- | ------------- | -------------|
@ -27,7 +27,7 @@ import org.openapitools.client.api.DashboardApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -96,7 +96,7 @@ import org.openapitools.client.api.DashboardApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
DashboardApi apiInstance = new DashboardApi(defaultClient); DashboardApi apiInstance = new DashboardApi(defaultClient);
String name = "name_example"; // String | The name of the page. String name = "name_example"; // String | The name of the page.

View File

@ -0,0 +1,13 @@
# DeinterlaceMethod
## Enum
* `YADIF` (value: `"yadif"`)
* `BWDIF` (value: `"bwdif"`)

View File

@ -1,13 +1,15 @@
# DeviceInfo # DeviceInfoDto
A DTO representing device information.
## Properties ## Properties
| Name | Type | Description | Notes | | Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------| |------------ | ------------- | ------------- | -------------|
|**name** | **String** | | [optional] | |**name** | **String** | Gets or sets the name. | [optional] |
|**customName** | **String** | Gets or sets the custom name. | [optional] |
|**accessToken** | **String** | Gets or sets the access token. | [optional] | |**accessToken** | **String** | Gets or sets the access token. | [optional] |
|**id** | **String** | Gets or sets the identifier. | [optional] | |**id** | **String** | Gets or sets the identifier. | [optional] |
|**lastUserName** | **String** | Gets or sets the last name of the user. | [optional] | |**lastUserName** | **String** | Gets or sets the last name of the user. | [optional] |
@ -15,8 +17,8 @@
|**appVersion** | **String** | Gets or sets the application version. | [optional] | |**appVersion** | **String** | Gets or sets the application version. | [optional] |
|**lastUserId** | **UUID** | Gets or sets the last user identifier. | [optional] | |**lastUserId** | **UUID** | Gets or sets the last user identifier. | [optional] |
|**dateLastActivity** | **OffsetDateTime** | Gets or sets the date last modified. | [optional] | |**dateLastActivity** | **OffsetDateTime** | Gets or sets the date last modified. | [optional] |
|**capabilities** | [**ClientCapabilities**](ClientCapabilities.md) | Gets or sets the capabilities. | [optional] | |**capabilities** | [**ClientCapabilitiesDto**](ClientCapabilitiesDto.md) | Gets or sets the capabilities. | [optional] |
|**iconUrl** | **String** | | [optional] | |**iconUrl** | **String** | Gets or sets the icon URL. | [optional] |

View File

@ -1,13 +1,14 @@
# DeviceInfoQueryResult # DeviceInfoDtoQueryResult
Query result container.
## Properties ## Properties
| Name | Type | Description | Notes | | Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------| |------------ | ------------- | ------------- | -------------|
|**items** | [**List&lt;DeviceInfo&gt;**](DeviceInfo.md) | Gets or sets the items. | [optional] | |**items** | [**List&lt;DeviceInfoDto&gt;**](DeviceInfoDto.md) | Gets or sets the items. | [optional] |
|**totalRecordCount** | **Integer** | Gets or sets the total number of records available. | [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] | |**startIndex** | **Integer** | Gets or sets the index of the first record in Items. | [optional] |

View File

@ -0,0 +1,24 @@
# DeviceProfile
A MediaBrowser.Model.Dlna.DeviceProfile represents a set of metadata which determines which content a certain device is able to play. <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. User profiles must have a unique name. | [optional] |
|**id** | **UUID** | Gets or sets the unique internal identifier. | [optional] |
|**maxStreamingBitrate** | **Integer** | Gets or sets the maximum allowed bitrate for all streamed content. | [optional] |
|**maxStaticBitrate** | **Integer** | Gets or sets the maximum allowed bitrate for statically streamed content (&#x3D; 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 (&#x3D; direct played) music files. | [optional] |
|**directPlayProfiles** | [**List&lt;DirectPlayProfile&gt;**](DirectPlayProfile.md) | Gets or sets the direct play profiles. | [optional] |
|**transcodingProfiles** | [**List&lt;TranscodingProfile&gt;**](TranscodingProfile.md) | Gets or sets the transcoding profiles. | [optional] |
|**containerProfiles** | [**List&lt;ContainerProfile&gt;**](ContainerProfile.md) | Gets or sets the container profiles. Failing to meet these optional conditions causes transcoding to occur. | [optional] |
|**codecProfiles** | [**List&lt;CodecProfile&gt;**](CodecProfile.md) | Gets or sets the codec profiles. | [optional] |
|**subtitleProfiles** | [**List&lt;SubtitleProfile&gt;**](SubtitleProfile.md) | Gets or sets the subtitle profiles. | [optional] |

View File

@ -1,6 +1,6 @@
# DevicesApi # DevicesApi
All URIs are relative to *http://nuc.ehrendingen:8096* All URIs are relative to *http://localhost*
| Method | HTTP request | Description | | Method | HTTP request | Description |
|------------- | ------------- | -------------| |------------- | ------------- | -------------|
@ -30,7 +30,7 @@ import org.openapitools.client.api.DevicesApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -82,7 +82,7 @@ null (empty response body)
<a id="getDeviceInfo"></a> <a id="getDeviceInfo"></a>
# **getDeviceInfo** # **getDeviceInfo**
> DeviceInfo getDeviceInfo(id) > DeviceInfoDto getDeviceInfo(id)
Get info for a device. Get info for a device.
@ -99,7 +99,7 @@ import org.openapitools.client.api.DevicesApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -110,7 +110,7 @@ public class Example {
DevicesApi apiInstance = new DevicesApi(defaultClient); DevicesApi apiInstance = new DevicesApi(defaultClient);
String id = "id_example"; // String | Device Id. String id = "id_example"; // String | Device Id.
try { try {
DeviceInfo result = apiInstance.getDeviceInfo(id); DeviceInfoDto result = apiInstance.getDeviceInfo(id);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling DevicesApi#getDeviceInfo"); System.err.println("Exception when calling DevicesApi#getDeviceInfo");
@ -131,7 +131,7 @@ public class Example {
### Return type ### Return type
[**DeviceInfo**](DeviceInfo.md) [**DeviceInfoDto**](DeviceInfoDto.md)
### Authorization ### Authorization
@ -152,7 +152,7 @@ public class Example {
<a id="getDeviceOptions"></a> <a id="getDeviceOptions"></a>
# **getDeviceOptions** # **getDeviceOptions**
> DeviceOptions getDeviceOptions(id) > DeviceOptionsDto getDeviceOptions(id)
Get options for a device. Get options for a device.
@ -169,7 +169,7 @@ import org.openapitools.client.api.DevicesApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -180,7 +180,7 @@ public class Example {
DevicesApi apiInstance = new DevicesApi(defaultClient); DevicesApi apiInstance = new DevicesApi(defaultClient);
String id = "id_example"; // String | Device Id. String id = "id_example"; // String | Device Id.
try { try {
DeviceOptions result = apiInstance.getDeviceOptions(id); DeviceOptionsDto result = apiInstance.getDeviceOptions(id);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling DevicesApi#getDeviceOptions"); System.err.println("Exception when calling DevicesApi#getDeviceOptions");
@ -201,7 +201,7 @@ public class Example {
### Return type ### Return type
[**DeviceOptions**](DeviceOptions.md) [**DeviceOptionsDto**](DeviceOptionsDto.md)
### Authorization ### Authorization
@ -222,7 +222,7 @@ public class Example {
<a id="getDevices"></a> <a id="getDevices"></a>
# **getDevices** # **getDevices**
> DeviceInfoQueryResult getDevices(supportsSync, userId) > DeviceInfoDtoQueryResult getDevices(userId)
Get Devices. Get Devices.
@ -239,7 +239,7 @@ import org.openapitools.client.api.DevicesApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -248,10 +248,9 @@ public class Example {
//CustomAuthentication.setApiKeyPrefix("Token"); //CustomAuthentication.setApiKeyPrefix("Token");
DevicesApi apiInstance = new DevicesApi(defaultClient); 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. UUID userId = UUID.randomUUID(); // UUID | Gets or sets the user identifier.
try { try {
DeviceInfoQueryResult result = apiInstance.getDevices(supportsSync, userId); DeviceInfoDtoQueryResult result = apiInstance.getDevices(userId);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling DevicesApi#getDevices"); System.err.println("Exception when calling DevicesApi#getDevices");
@ -268,12 +267,11 @@ public class Example {
| Name | Type | Description | Notes | | 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] | | **userId** | **UUID**| Gets or sets the user identifier. | [optional] |
### Return type ### Return type
[**DeviceInfoQueryResult**](DeviceInfoQueryResult.md) [**DeviceInfoDtoQueryResult**](DeviceInfoDtoQueryResult.md)
### Authorization ### Authorization
@ -310,7 +308,7 @@ import org.openapitools.client.api.DevicesApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");

View File

@ -0,0 +1,17 @@
# DirectPlayProfile
Defines the MediaBrowser.Model.Dlna.DirectPlayProfile.
## Properties
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**container** | **String** | Gets or sets the container. | [optional] |
|**audioCodec** | **String** | Gets or sets the audio codec. | [optional] |
|**videoCodec** | **String** | Gets or sets the video codec. | [optional] |
|**type** | **DlnaProfileType** | Gets or sets the Dlna profile type. | [optional] |

View File

@ -1,6 +1,6 @@
# DisplayPreferencesApi # DisplayPreferencesApi
All URIs are relative to *http://nuc.ehrendingen:8096* All URIs are relative to *http://localhost*
| Method | HTTP request | Description | | Method | HTTP request | Description |
|------------- | ------------- | -------------| |------------- | ------------- | -------------|
@ -10,7 +10,7 @@ All URIs are relative to *http://nuc.ehrendingen:8096*
<a id="getDisplayPreferences"></a> <a id="getDisplayPreferences"></a>
# **getDisplayPreferences** # **getDisplayPreferences**
> DisplayPreferencesDto getDisplayPreferences(displayPreferencesId, userId, client) > DisplayPreferencesDto getDisplayPreferences(displayPreferencesId, client, userId)
Get Display Preferences. Get Display Preferences.
@ -27,7 +27,7 @@ import org.openapitools.client.api.DisplayPreferencesApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -37,10 +37,10 @@ public class Example {
DisplayPreferencesApi apiInstance = new DisplayPreferencesApi(defaultClient); DisplayPreferencesApi apiInstance = new DisplayPreferencesApi(defaultClient);
String displayPreferencesId = "displayPreferencesId_example"; // String | Display preferences id. String displayPreferencesId = "displayPreferencesId_example"; // String | Display preferences id.
UUID userId = UUID.randomUUID(); // UUID | User id.
String client = "client_example"; // String | Client. String client = "client_example"; // String | Client.
UUID userId = UUID.randomUUID(); // UUID | User id.
try { try {
DisplayPreferencesDto result = apiInstance.getDisplayPreferences(displayPreferencesId, userId, client); DisplayPreferencesDto result = apiInstance.getDisplayPreferences(displayPreferencesId, client, userId);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling DisplayPreferencesApi#getDisplayPreferences"); System.err.println("Exception when calling DisplayPreferencesApi#getDisplayPreferences");
@ -58,8 +58,8 @@ public class Example {
| Name | Type | Description | Notes | | Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------| |------------- | ------------- | ------------- | -------------|
| **displayPreferencesId** | **String**| Display preferences id. | | | **displayPreferencesId** | **String**| Display preferences id. | |
| **userId** | **UUID**| User id. | |
| **client** | **String**| Client. | | | **client** | **String**| Client. | |
| **userId** | **UUID**| User id. | [optional] |
### Return type ### Return type
@ -83,7 +83,7 @@ public class Example {
<a id="updateDisplayPreferences"></a> <a id="updateDisplayPreferences"></a>
# **updateDisplayPreferences** # **updateDisplayPreferences**
> updateDisplayPreferences(displayPreferencesId, userId, client, displayPreferencesDto) > updateDisplayPreferences(displayPreferencesId, client, displayPreferencesDto, userId)
Update Display Preferences. Update Display Preferences.
@ -100,7 +100,7 @@ import org.openapitools.client.api.DisplayPreferencesApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -110,11 +110,11 @@ public class Example {
DisplayPreferencesApi apiInstance = new DisplayPreferencesApi(defaultClient); DisplayPreferencesApi apiInstance = new DisplayPreferencesApi(defaultClient);
String displayPreferencesId = "displayPreferencesId_example"; // String | Display preferences id. String displayPreferencesId = "displayPreferencesId_example"; // String | Display preferences id.
UUID userId = UUID.randomUUID(); // UUID | User Id.
String client = "client_example"; // String | Client. String client = "client_example"; // String | Client.
DisplayPreferencesDto displayPreferencesDto = new DisplayPreferencesDto(); // DisplayPreferencesDto | New Display Preferences object. DisplayPreferencesDto displayPreferencesDto = new DisplayPreferencesDto(); // DisplayPreferencesDto | New Display Preferences object.
UUID userId = UUID.randomUUID(); // UUID | User Id.
try { try {
apiInstance.updateDisplayPreferences(displayPreferencesId, userId, client, displayPreferencesDto); apiInstance.updateDisplayPreferences(displayPreferencesId, client, displayPreferencesDto, userId);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling DisplayPreferencesApi#updateDisplayPreferences"); System.err.println("Exception when calling DisplayPreferencesApi#updateDisplayPreferences");
System.err.println("Status code: " + e.getCode()); System.err.println("Status code: " + e.getCode());
@ -131,9 +131,9 @@ public class Example {
| Name | Type | Description | Notes | | Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------| |------------- | ------------- | ------------- | -------------|
| **displayPreferencesId** | **String**| Display preferences id. | | | **displayPreferencesId** | **String**| Display preferences id. | |
| **userId** | **UUID**| User Id. | |
| **client** | **String**| Client. | | | **client** | **String**| Client. | |
| **displayPreferencesDto** | [**DisplayPreferencesDto**](DisplayPreferencesDto.md)| New Display Preferences object. | | | **displayPreferencesDto** | [**DisplayPreferencesDto**](DisplayPreferencesDto.md)| New Display Preferences object. | |
| **userId** | **UUID**| User Id. | [optional] |
### Return type ### Return type

View File

@ -16,10 +16,10 @@ Defines the display preferences for any item that supports them (usually Folders
|**primaryImageHeight** | **Integer** | Gets or sets the height of the primary image. | [optional] | |**primaryImageHeight** | **Integer** | Gets or sets the height of the primary image. | [optional] |
|**primaryImageWidth** | **Integer** | Gets or sets the width of the primary image. | [optional] | |**primaryImageWidth** | **Integer** | Gets or sets the width of the primary image. | [optional] |
|**customPrefs** | **Map&lt;String, String&gt;** | Gets or sets the custom prefs. | [optional] | |**customPrefs** | **Map&lt;String, String&gt;** | Gets or sets the custom prefs. | [optional] |
|**scrollDirection** | **ScrollDirection** | Gets or sets the scroll direction. | [optional] | |**scrollDirection** | **ScrollDirection** | An enum representing the axis that should be scrolled. | [optional] |
|**showBackdrop** | **Boolean** | Gets or sets a value indicating whether to show backdrops on this item. | [optional] | |**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] | |**rememberSorting** | **Boolean** | Gets or sets a value indicating whether [remember sorting]. | [optional] |
|**sortOrder** | **SortOrder** | Gets or sets the sort order. | [optional] | |**sortOrder** | **SortOrder** | An enum representing the sorting order. | [optional] |
|**showSidebar** | **Boolean** | Gets or sets a value indicating whether [show sidebar]. | [optional] | |**showSidebar** | **Boolean** | Gets or sets a value indicating whether [show sidebar]. | [optional] |
|**client** | **String** | Gets or sets the client. | [optional] | |**client** | **String** | Gets or sets the client. | [optional] |

View File

@ -0,0 +1,19 @@
# DownMixStereoAlgorithms
## Enum
* `NONE` (value: `"None"`)
* `DAVE750` (value: `"Dave750"`)
* `NIGHTMODE_DIALOGUE` (value: `"NightmodeDialogue"`)
* `RFC7845` (value: `"Rfc7845"`)
* `AC4` (value: `"Ac4"`)

View File

@ -1,6 +1,6 @@
# DynamicHlsApi # DynamicHlsApi
All URIs are relative to *http://nuc.ehrendingen:8096* All URIs are relative to *http://localhost*
| Method | HTTP request | Description | | Method | HTTP request | Description |
|------------- | ------------- | -------------| |------------- | ------------- | -------------|
@ -17,7 +17,7 @@ All URIs are relative to *http://nuc.ehrendingen:8096*
<a id="getHlsAudioSegment"></a> <a id="getHlsAudioSegment"></a>
# **getHlsAudioSegment** # **getHlsAudioSegment**
> File getHlsAudioSegment(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions) > File getHlsAudioSegment(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding)
Gets a video stream using HTTP live streaming. Gets a video stream using HTTP live streaming.
@ -34,7 +34,7 @@ import org.openapitools.client.api.DynamicHlsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -59,7 +59,7 @@ public class Example {
Integer minSegments = 56; // Integer | The minimum number of segments. Integer minSegments = 56; // Integer | The minimum number of segments.
String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. 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 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. String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3.
Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. Boolean 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 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 allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url.
@ -90,15 +90,16 @@ public class Example {
Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use.
String liveStreamId = "liveStreamId_example"; // String | The live stream id. String liveStreamId = "liveStreamId_example"; // String | The live stream id.
Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. 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, vpx, wmv. String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264.
String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to.
String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. 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 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. 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. 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. Map<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding.
try { try {
File result = apiInstance.getHlsAudioSegment(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions); File result = apiInstance.getHlsAudioSegment(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling DynamicHlsApi#getHlsAudioSegment"); System.err.println("Exception when calling DynamicHlsApi#getHlsAudioSegment");
@ -131,7 +132,7 @@ public class Example {
| **minSegments** | **Integer**| The minimum number of segments. | [optional] | | **minSegments** | **Integer**| The minimum number of segments. | [optional] |
| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [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] | | **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&#39;s extension. Options: aac, mp3, vorbis, wma. | [optional] | | **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] |
| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | | **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] | | **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] | | **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] |
@ -152,7 +153,7 @@ public class Example {
| **height** | **Integer**| Optional. The fixed vertical 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] | | **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] | | **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] | | **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] |
| **maxRefFrames** | **Integer**| Optional. | [optional] | | **maxRefFrames** | **Integer**| Optional. | [optional] |
| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | | **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] |
| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | | **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] |
@ -162,13 +163,14 @@ public class Example {
| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | | **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] |
| **liveStreamId** | **String**| The live stream id. | [optional] | | **liveStreamId** | **String**| The live stream id. | [optional] |
| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [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&#39;s extension. Options: h265, h264, mpeg4, theora, vpx, wmv. | [optional] | | **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] |
| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | | **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] |
| **transcodeReasons** | **String**| Optional. The transcoding reason. | [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] | | **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] | | **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] | | **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
| **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] | | **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] |
| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] |
### Return type ### Return type
@ -192,7 +194,7 @@ public class Example {
<a id="getHlsVideoSegment"></a> <a id="getHlsVideoSegment"></a>
# **getHlsVideoSegment** # **getHlsVideoSegment**
> File getHlsVideoSegment(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions) > File getHlsVideoSegment(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding)
Gets a video stream using HTTP live streaming. Gets a video stream using HTTP live streaming.
@ -209,7 +211,7 @@ import org.openapitools.client.api.DynamicHlsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -234,7 +236,7 @@ public class Example {
Integer minSegments = 56; // Integer | The minimum number of segments. Integer minSegments = 56; // Integer | The minimum number of segments.
String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. 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 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. String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3.
Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. Boolean 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 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 allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url.
@ -266,15 +268,17 @@ public class Example {
Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use.
String liveStreamId = "liveStreamId_example"; // String | The live stream id. String liveStreamId = "liveStreamId_example"; // String | The live stream id.
Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. 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 videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264.
String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to.
String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. 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 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. 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. 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. Map<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding.
Boolean alwaysBurnInSubtitleWhenTranscoding = false; // Boolean | Whether to always burn in subtitles when transcoding.
try { try {
File result = apiInstance.getHlsVideoSegment(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions); File result = apiInstance.getHlsVideoSegment(itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling DynamicHlsApi#getHlsVideoSegment"); System.err.println("Exception when calling DynamicHlsApi#getHlsVideoSegment");
@ -307,7 +311,7 @@ public class Example {
| **minSegments** | **Integer**| The minimum number of segments. | [optional] | | **minSegments** | **Integer**| The minimum number of segments. | [optional] |
| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [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] | | **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&#39;s extension. Options: aac, mp3, vorbis, wma. | [optional] | | **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] |
| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | | **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] | | **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] | | **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] |
@ -329,7 +333,7 @@ public class Example {
| **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] | | **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] |
| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | | **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] | | **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] | | **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] |
| **maxRefFrames** | **Integer**| Optional. | [optional] | | **maxRefFrames** | **Integer**| Optional. | [optional] |
| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | | **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] |
| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | | **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] |
@ -339,13 +343,15 @@ public class Example {
| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | | **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] |
| **liveStreamId** | **String**| The live stream id. | [optional] | | **liveStreamId** | **String**| The live stream id. | [optional] |
| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [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&#39;s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. | [optional] | | **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] |
| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | | **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] |
| **transcodeReasons** | **String**| Optional. The transcoding reason. | [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] | | **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] | | **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] | | **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
| **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] | | **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] |
| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] |
| **alwaysBurnInSubtitleWhenTranscoding** | **Boolean**| Whether to always burn in subtitles when transcoding. | [optional] [default to false] |
### Return type ### Return type
@ -369,7 +375,7 @@ public class Example {
<a id="getLiveHlsStream"></a> <a id="getLiveHlsStream"></a>
# **getLiveHlsStream** # **getLiveHlsStream**
> File getLiveHlsStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, maxWidth, maxHeight, enableSubtitlesInManifest) > File getLiveHlsStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, maxWidth, maxHeight, enableSubtitlesInManifest, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding)
Gets a hls live stream. Gets a hls live stream.
@ -386,7 +392,7 @@ import org.openapitools.client.api.DynamicHlsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -403,11 +409,11 @@ public class Example {
String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize. String deviceProfileId = "deviceProfileId_example"; // String | Optional. The dlna device profile id to utilize.
String playSessionId = "playSessionId_example"; // String | The play session id. String playSessionId = "playSessionId_example"; // String | The play session id.
String segmentContainer = "segmentContainer_example"; // String | The segment container. String segmentContainer = "segmentContainer_example"; // String | The segment container.
Integer segmentLength = 56; // Integer | The segment lenght. Integer segmentLength = 56; // Integer | The segment length.
Integer minSegments = 56; // Integer | The minimum number of segments. Integer minSegments = 56; // Integer | The minimum number of segments.
String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. 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 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. String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3.
Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. Boolean 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 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 allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url.
@ -437,7 +443,7 @@ public class Example {
Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use.
String liveStreamId = "liveStreamId_example"; // String | The live stream id. String liveStreamId = "liveStreamId_example"; // String | The live stream id.
Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. 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 videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264.
String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to.
String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. 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 audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
@ -447,8 +453,10 @@ public class Example {
Integer maxWidth = 56; // Integer | Optional. The max width. Integer maxWidth = 56; // Integer | Optional. The max width.
Integer maxHeight = 56; // Integer | Optional. The max height. Integer maxHeight = 56; // Integer | Optional. The max height.
Boolean enableSubtitlesInManifest = true; // Boolean | Optional. Whether to enable subtitles in the manifest. Boolean enableSubtitlesInManifest = true; // Boolean | Optional. Whether to enable subtitles in the manifest.
Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding.
Boolean alwaysBurnInSubtitleWhenTranscoding = false; // Boolean | Whether to always burn in subtitles when transcoding.
try { try {
File result = apiInstance.getLiveHlsStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, maxWidth, maxHeight, enableSubtitlesInManifest); File result = apiInstance.getLiveHlsStream(itemId, container, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, maxWidth, maxHeight, enableSubtitlesInManifest, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling DynamicHlsApi#getLiveHlsStream"); System.err.println("Exception when calling DynamicHlsApi#getLiveHlsStream");
@ -473,11 +481,11 @@ public class Example {
| **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] | | **deviceProfileId** | **String**| Optional. The dlna device profile id to utilize. | [optional] |
| **playSessionId** | **String**| The play session id. | [optional] | | **playSessionId** | **String**| The play session id. | [optional] |
| **segmentContainer** | **String**| The segment container. | [optional] | | **segmentContainer** | **String**| The segment container. | [optional] |
| **segmentLength** | **Integer**| The segment lenght. | [optional] | | **segmentLength** | **Integer**| The segment length. | [optional] |
| **minSegments** | **Integer**| The minimum number of segments. | [optional] | | **minSegments** | **Integer**| The minimum number of segments. | [optional] |
| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [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] | | **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&#39;s extension. Options: aac, mp3, vorbis, wma. | [optional] | | **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] |
| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | | **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] | | **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] | | **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] |
@ -497,7 +505,7 @@ public class Example {
| **height** | **Integer**| Optional. The fixed vertical 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] | | **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] | | **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] | | **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] |
| **maxRefFrames** | **Integer**| Optional. | [optional] | | **maxRefFrames** | **Integer**| Optional. | [optional] |
| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | | **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] |
| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | | **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] |
@ -507,16 +515,18 @@ public class Example {
| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | | **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] |
| **liveStreamId** | **String**| The live stream id. | [optional] | | **liveStreamId** | **String**| The live stream id. | [optional] |
| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [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&#39;s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. | [optional] | | **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] |
| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | | **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] |
| **transcodeReasons** | **String**| Optional. The transcoding reason. | [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] | | **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] | | **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] | | **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
| **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] | | **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] |
| **maxWidth** | **Integer**| Optional. The max width. | [optional] | | **maxWidth** | **Integer**| Optional. The max width. | [optional] |
| **maxHeight** | **Integer**| Optional. The max height. | [optional] | | **maxHeight** | **Integer**| Optional. The max height. | [optional] |
| **enableSubtitlesInManifest** | **Boolean**| Optional. Whether to enable subtitles in the manifest. | [optional] | | **enableSubtitlesInManifest** | **Boolean**| Optional. Whether to enable subtitles in the manifest. | [optional] |
| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] |
| **alwaysBurnInSubtitleWhenTranscoding** | **Boolean**| Whether to always burn in subtitles when transcoding. | [optional] [default to false] |
### Return type ### Return type
@ -540,7 +550,7 @@ public class Example {
<a id="getMasterHlsAudioPlaylist"></a> <a id="getMasterHlsAudioPlaylist"></a>
# **getMasterHlsAudioPlaylist** # **getMasterHlsAudioPlaylist**
> File getMasterHlsAudioPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming) > File getMasterHlsAudioPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding)
Gets an audio hls playlist stream. Gets an audio hls playlist stream.
@ -557,7 +567,7 @@ import org.openapitools.client.api.DynamicHlsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -577,7 +587,7 @@ public class Example {
Integer segmentLength = 56; // Integer | The segment length. Integer segmentLength = 56; // Integer | The segment length.
Integer minSegments = 56; // Integer | The minimum number of segments. Integer minSegments = 56; // Integer | The minimum number of segments.
String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. String 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. String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3.
Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. Boolean 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 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 allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url.
@ -608,7 +618,7 @@ public class Example {
Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use.
String liveStreamId = "liveStreamId_example"; // String | The live stream id. String liveStreamId = "liveStreamId_example"; // String | The live stream id.
Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. 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 videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264.
String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to.
String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. 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 audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
@ -616,8 +626,9 @@ public class Example {
EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. 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. Map<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
Boolean enableAdaptiveBitrateStreaming = true; // Boolean | Enable adaptive bitrate streaming. Boolean enableAdaptiveBitrateStreaming = true; // Boolean | Enable adaptive bitrate streaming.
Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding.
try { try {
File result = apiInstance.getMasterHlsAudioPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming); File result = apiInstance.getMasterHlsAudioPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling DynamicHlsApi#getMasterHlsAudioPlaylist"); System.err.println("Exception when calling DynamicHlsApi#getMasterHlsAudioPlaylist");
@ -645,7 +656,7 @@ public class Example {
| **segmentLength** | **Integer**| The segment length. | [optional] | | **segmentLength** | **Integer**| The segment length. | [optional] |
| **minSegments** | **Integer**| The minimum number of segments. | [optional] | | **minSegments** | **Integer**| The minimum number of segments. | [optional] |
| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | | **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&#39;s extension. Options: aac, mp3, vorbis, wma. | [optional] | | **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] |
| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | | **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] | | **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] | | **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] |
@ -666,7 +677,7 @@ public class Example {
| **height** | **Integer**| Optional. The fixed vertical 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] | | **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] | | **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] | | **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] |
| **maxRefFrames** | **Integer**| Optional. | [optional] | | **maxRefFrames** | **Integer**| Optional. | [optional] |
| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | | **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] |
| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | | **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] |
@ -676,14 +687,15 @@ public class Example {
| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | | **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] |
| **liveStreamId** | **String**| The live stream id. | [optional] | | **liveStreamId** | **String**| The live stream id. | [optional] |
| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [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&#39;s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. | [optional] | | **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] |
| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | | **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] |
| **transcodeReasons** | **String**| Optional. The transcoding reason. | [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] | | **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] | | **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] | | **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
| **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] | | **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] |
| **enableAdaptiveBitrateStreaming** | **Boolean**| Enable adaptive bitrate streaming. | [optional] [default to true] | | **enableAdaptiveBitrateStreaming** | **Boolean**| Enable adaptive bitrate streaming. | [optional] [default to true] |
| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] |
### Return type ### Return type
@ -707,7 +719,7 @@ public class Example {
<a id="getMasterHlsVideoPlaylist"></a> <a id="getMasterHlsVideoPlaylist"></a>
# **getMasterHlsVideoPlaylist** # **getMasterHlsVideoPlaylist**
> File getMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming) > File getMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding)
Gets a video hls playlist stream. Gets a video hls playlist stream.
@ -724,7 +736,7 @@ import org.openapitools.client.api.DynamicHlsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -744,7 +756,7 @@ public class Example {
Integer segmentLength = 56; // Integer | The segment length. Integer segmentLength = 56; // Integer | The segment length.
Integer minSegments = 56; // Integer | The minimum number of segments. Integer minSegments = 56; // Integer | The minimum number of segments.
String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. String 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. String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3.
Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. Boolean 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 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 allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url.
@ -776,7 +788,7 @@ public class Example {
Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use.
String liveStreamId = "liveStreamId_example"; // String | The live stream id. String liveStreamId = "liveStreamId_example"; // String | The live stream id.
Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. 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 videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264.
String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to.
String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. 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 audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
@ -784,8 +796,11 @@ public class Example {
EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. 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. Map<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
Boolean enableAdaptiveBitrateStreaming = true; // Boolean | Enable adaptive bitrate streaming. Boolean enableAdaptiveBitrateStreaming = true; // Boolean | Enable adaptive bitrate streaming.
Boolean enableTrickplay = true; // Boolean | Enable trickplay image playlists being added to master playlist.
Boolean enableAudioVbrEncoding = true; // Boolean | Whether to enable Audio Encoding.
Boolean alwaysBurnInSubtitleWhenTranscoding = false; // Boolean | Whether to always burn in subtitles when transcoding.
try { try {
File result = apiInstance.getMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming); File result = apiInstance.getMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling DynamicHlsApi#getMasterHlsVideoPlaylist"); System.err.println("Exception when calling DynamicHlsApi#getMasterHlsVideoPlaylist");
@ -813,7 +828,7 @@ public class Example {
| **segmentLength** | **Integer**| The segment length. | [optional] | | **segmentLength** | **Integer**| The segment length. | [optional] |
| **minSegments** | **Integer**| The minimum number of segments. | [optional] | | **minSegments** | **Integer**| The minimum number of segments. | [optional] |
| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | | **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&#39;s extension. Options: aac, mp3, vorbis, wma. | [optional] | | **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] |
| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | | **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] | | **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] | | **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] |
@ -835,7 +850,7 @@ public class Example {
| **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] | | **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] |
| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | | **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] | | **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] | | **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] |
| **maxRefFrames** | **Integer**| Optional. | [optional] | | **maxRefFrames** | **Integer**| Optional. | [optional] |
| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | | **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] |
| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | | **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] |
@ -845,14 +860,17 @@ public class Example {
| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | | **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] |
| **liveStreamId** | **String**| The live stream id. | [optional] | | **liveStreamId** | **String**| The live stream id. | [optional] |
| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [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&#39;s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. | [optional] | | **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] |
| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | | **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] |
| **transcodeReasons** | **String**| Optional. The transcoding reason. | [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] | | **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] | | **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] | | **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
| **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] | | **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] |
| **enableAdaptiveBitrateStreaming** | **Boolean**| Enable adaptive bitrate streaming. | [optional] [default to true] | | **enableAdaptiveBitrateStreaming** | **Boolean**| Enable adaptive bitrate streaming. | [optional] [default to true] |
| **enableTrickplay** | **Boolean**| Enable trickplay image playlists being added to master playlist. | [optional] [default to true] |
| **enableAudioVbrEncoding** | **Boolean**| Whether to enable Audio Encoding. | [optional] [default to true] |
| **alwaysBurnInSubtitleWhenTranscoding** | **Boolean**| Whether to always burn in subtitles when transcoding. | [optional] [default to false] |
### Return type ### Return type
@ -876,7 +894,7 @@ public class Example {
<a id="getVariantHlsAudioPlaylist"></a> <a id="getVariantHlsAudioPlaylist"></a>
# **getVariantHlsAudioPlaylist** # **getVariantHlsAudioPlaylist**
> File getVariantHlsAudioPlaylist(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions) > File getVariantHlsAudioPlaylist(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding)
Gets an audio stream using HTTP live streaming. Gets an audio stream using HTTP live streaming.
@ -893,7 +911,7 @@ import org.openapitools.client.api.DynamicHlsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -913,7 +931,7 @@ public class Example {
Integer minSegments = 56; // Integer | The minimum number of segments. Integer minSegments = 56; // Integer | The minimum number of segments.
String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. 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 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. String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3.
Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. Boolean 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 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 allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url.
@ -944,15 +962,16 @@ public class Example {
Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use.
String liveStreamId = "liveStreamId_example"; // String | The live stream id. String liveStreamId = "liveStreamId_example"; // String | The live stream id.
Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. 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, vpx, wmv. String videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264.
String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to.
String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. 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 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. 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. 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. Map<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding.
try { try {
File result = apiInstance.getVariantHlsAudioPlaylist(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions); File result = apiInstance.getVariantHlsAudioPlaylist(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling DynamicHlsApi#getVariantHlsAudioPlaylist"); System.err.println("Exception when calling DynamicHlsApi#getVariantHlsAudioPlaylist");
@ -980,7 +999,7 @@ public class Example {
| **minSegments** | **Integer**| The minimum number of segments. | [optional] | | **minSegments** | **Integer**| The minimum number of segments. | [optional] |
| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [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] | | **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&#39;s extension. Options: aac, mp3, vorbis, wma. | [optional] | | **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] |
| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | | **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] | | **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] | | **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] |
@ -1001,7 +1020,7 @@ public class Example {
| **height** | **Integer**| Optional. The fixed vertical 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] | | **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] | | **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] | | **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] |
| **maxRefFrames** | **Integer**| Optional. | [optional] | | **maxRefFrames** | **Integer**| Optional. | [optional] |
| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | | **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] |
| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | | **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] |
@ -1011,13 +1030,14 @@ public class Example {
| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | | **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] |
| **liveStreamId** | **String**| The live stream id. | [optional] | | **liveStreamId** | **String**| The live stream id. | [optional] |
| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [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&#39;s extension. Options: h265, h264, mpeg4, theora, vpx, wmv. | [optional] | | **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] |
| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | | **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] |
| **transcodeReasons** | **String**| Optional. The transcoding reason. | [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] | | **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] | | **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] | | **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
| **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] | | **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] |
| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] |
### Return type ### Return type
@ -1041,7 +1061,7 @@ public class Example {
<a id="getVariantHlsVideoPlaylist"></a> <a id="getVariantHlsVideoPlaylist"></a>
# **getVariantHlsVideoPlaylist** # **getVariantHlsVideoPlaylist**
> File getVariantHlsVideoPlaylist(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions) > File getVariantHlsVideoPlaylist(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding)
Gets a video stream using HTTP live streaming. Gets a video stream using HTTP live streaming.
@ -1058,7 +1078,7 @@ import org.openapitools.client.api.DynamicHlsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -1078,7 +1098,7 @@ public class Example {
Integer minSegments = 56; // Integer | The minimum number of segments. Integer minSegments = 56; // Integer | The minimum number of segments.
String mediaSourceId = "mediaSourceId_example"; // String | The media version id, if playing an alternate version. 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 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. String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3.
Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. Boolean 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 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 allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url.
@ -1110,15 +1130,17 @@ public class Example {
Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use.
String liveStreamId = "liveStreamId_example"; // String | The live stream id. String liveStreamId = "liveStreamId_example"; // String | The live stream id.
Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. 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 videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264.
String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to.
String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. 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 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. 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. 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. Map<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding.
Boolean alwaysBurnInSubtitleWhenTranscoding = false; // Boolean | Whether to always burn in subtitles when transcoding.
try { try {
File result = apiInstance.getVariantHlsVideoPlaylist(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions); File result = apiInstance.getVariantHlsVideoPlaylist(itemId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, mediaSourceId, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling DynamicHlsApi#getVariantHlsVideoPlaylist"); System.err.println("Exception when calling DynamicHlsApi#getVariantHlsVideoPlaylist");
@ -1146,7 +1168,7 @@ public class Example {
| **minSegments** | **Integer**| The minimum number of segments. | [optional] | | **minSegments** | **Integer**| The minimum number of segments. | [optional] |
| **mediaSourceId** | **String**| The media version id, if playing an alternate version. | [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] | | **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&#39;s extension. Options: aac, mp3, vorbis, wma. | [optional] | | **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] |
| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | | **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] | | **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] | | **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] |
@ -1168,7 +1190,7 @@ public class Example {
| **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] | | **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] |
| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | | **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] | | **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] | | **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] |
| **maxRefFrames** | **Integer**| Optional. | [optional] | | **maxRefFrames** | **Integer**| Optional. | [optional] |
| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | | **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] |
| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | | **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] |
@ -1178,13 +1200,15 @@ public class Example {
| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | | **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] |
| **liveStreamId** | **String**| The live stream id. | [optional] | | **liveStreamId** | **String**| The live stream id. | [optional] |
| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [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&#39;s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. | [optional] | | **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] |
| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | | **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] |
| **transcodeReasons** | **String**| Optional. The transcoding reason. | [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] | | **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] | | **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] | | **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
| **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] | | **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] |
| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] |
| **alwaysBurnInSubtitleWhenTranscoding** | **Boolean**| Whether to always burn in subtitles when transcoding. | [optional] [default to false] |
### Return type ### Return type
@ -1208,7 +1232,7 @@ public class Example {
<a id="headMasterHlsAudioPlaylist"></a> <a id="headMasterHlsAudioPlaylist"></a>
# **headMasterHlsAudioPlaylist** # **headMasterHlsAudioPlaylist**
> File headMasterHlsAudioPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming) > File headMasterHlsAudioPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding)
Gets an audio hls playlist stream. Gets an audio hls playlist stream.
@ -1225,7 +1249,7 @@ import org.openapitools.client.api.DynamicHlsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -1245,7 +1269,7 @@ public class Example {
Integer segmentLength = 56; // Integer | The segment length. Integer segmentLength = 56; // Integer | The segment length.
Integer minSegments = 56; // Integer | The minimum number of segments. Integer minSegments = 56; // Integer | The minimum number of segments.
String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. String 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. String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3.
Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. Boolean 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 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 allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url.
@ -1276,7 +1300,7 @@ public class Example {
Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use.
String liveStreamId = "liveStreamId_example"; // String | The live stream id. String liveStreamId = "liveStreamId_example"; // String | The live stream id.
Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. 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 videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264.
String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to.
String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. 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 audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
@ -1284,8 +1308,9 @@ public class Example {
EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. 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. Map<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
Boolean enableAdaptiveBitrateStreaming = true; // Boolean | Enable adaptive bitrate streaming. Boolean enableAdaptiveBitrateStreaming = true; // Boolean | Enable adaptive bitrate streaming.
Boolean enableAudioVbrEncoding = true; // Boolean | Optional. Whether to enable Audio Encoding.
try { try {
File result = apiInstance.headMasterHlsAudioPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming); File result = apiInstance.headMasterHlsAudioPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, maxStreamingBitrate, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableAudioVbrEncoding);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling DynamicHlsApi#headMasterHlsAudioPlaylist"); System.err.println("Exception when calling DynamicHlsApi#headMasterHlsAudioPlaylist");
@ -1313,7 +1338,7 @@ public class Example {
| **segmentLength** | **Integer**| The segment length. | [optional] | | **segmentLength** | **Integer**| The segment length. | [optional] |
| **minSegments** | **Integer**| The minimum number of segments. | [optional] | | **minSegments** | **Integer**| The minimum number of segments. | [optional] |
| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | | **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&#39;s extension. Options: aac, mp3, vorbis, wma. | [optional] | | **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] |
| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | | **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] | | **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] | | **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] |
@ -1334,7 +1359,7 @@ public class Example {
| **height** | **Integer**| Optional. The fixed vertical 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] | | **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] | | **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] | | **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] |
| **maxRefFrames** | **Integer**| Optional. | [optional] | | **maxRefFrames** | **Integer**| Optional. | [optional] |
| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | | **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] |
| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | | **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] |
@ -1344,14 +1369,15 @@ public class Example {
| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | | **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] |
| **liveStreamId** | **String**| The live stream id. | [optional] | | **liveStreamId** | **String**| The live stream id. | [optional] |
| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [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&#39;s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. | [optional] | | **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] |
| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | | **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] |
| **transcodeReasons** | **String**| Optional. The transcoding reason. | [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] | | **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] | | **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] | | **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
| **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] | | **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] |
| **enableAdaptiveBitrateStreaming** | **Boolean**| Enable adaptive bitrate streaming. | [optional] [default to true] | | **enableAdaptiveBitrateStreaming** | **Boolean**| Enable adaptive bitrate streaming. | [optional] [default to true] |
| **enableAudioVbrEncoding** | **Boolean**| Optional. Whether to enable Audio Encoding. | [optional] [default to true] |
### Return type ### Return type
@ -1375,7 +1401,7 @@ public class Example {
<a id="headMasterHlsVideoPlaylist"></a> <a id="headMasterHlsVideoPlaylist"></a>
# **headMasterHlsVideoPlaylist** # **headMasterHlsVideoPlaylist**
> File headMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming) > File headMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding)
Gets a video hls playlist stream. Gets a video hls playlist stream.
@ -1392,7 +1418,7 @@ import org.openapitools.client.api.DynamicHlsApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -1412,7 +1438,7 @@ public class Example {
Integer segmentLength = 56; // Integer | The segment length. Integer segmentLength = 56; // Integer | The segment length.
Integer minSegments = 56; // Integer | The minimum number of segments. Integer minSegments = 56; // Integer | The minimum number of segments.
String deviceId = "deviceId_example"; // String | The device id of the client requesting. Used to stop encoding processes when needed. String 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. String audioCodec = "audioCodec_example"; // String | Optional. Specify an audio codec to encode to, e.g. mp3.
Boolean enableAutoStreamCopy = true; // Boolean | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. Boolean 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 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 allowAudioStreamCopy = true; // Boolean | Whether or not to allow copying of the audio stream url.
@ -1444,7 +1470,7 @@ public class Example {
Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use. Integer cpuCoreLimit = 56; // Integer | Optional. The limit of how many cpu cores to use.
String liveStreamId = "liveStreamId_example"; // String | The live stream id. String liveStreamId = "liveStreamId_example"; // String | The live stream id.
Boolean enableMpegtsM2TsMode = true; // Boolean | Optional. Whether to enable the MpegtsM2Ts mode. 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 videoCodec = "videoCodec_example"; // String | Optional. Specify a video codec to encode to, e.g. h264.
String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to. String subtitleCodec = "subtitleCodec_example"; // String | Optional. Specify a subtitle codec to encode to.
String transcodeReasons = "transcodeReasons_example"; // String | Optional. The transcoding reason. 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 audioStreamIndex = 56; // Integer | Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
@ -1452,8 +1478,11 @@ public class Example {
EncodingContext context = EncodingContext.fromValue("Streaming"); // EncodingContext | Optional. The MediaBrowser.Model.Dlna.EncodingContext. 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. Map<String, String> streamOptions = new HashMap(); // Map<String, String> | Optional. The streaming options.
Boolean enableAdaptiveBitrateStreaming = true; // Boolean | Enable adaptive bitrate streaming. Boolean enableAdaptiveBitrateStreaming = true; // Boolean | Enable adaptive bitrate streaming.
Boolean enableTrickplay = true; // Boolean | Enable trickplay image playlists being added to master playlist.
Boolean enableAudioVbrEncoding = true; // Boolean | Whether to enable Audio Encoding.
Boolean alwaysBurnInSubtitleWhenTranscoding = false; // Boolean | Whether to always burn in subtitles when transcoding.
try { try {
File result = apiInstance.headMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming); File result = apiInstance.headMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, enableAudioVbrEncoding, alwaysBurnInSubtitleWhenTranscoding);
System.out.println(result); System.out.println(result);
} catch (ApiException e) { } catch (ApiException e) {
System.err.println("Exception when calling DynamicHlsApi#headMasterHlsVideoPlaylist"); System.err.println("Exception when calling DynamicHlsApi#headMasterHlsVideoPlaylist");
@ -1481,7 +1510,7 @@ public class Example {
| **segmentLength** | **Integer**| The segment length. | [optional] | | **segmentLength** | **Integer**| The segment length. | [optional] |
| **minSegments** | **Integer**| The minimum number of segments. | [optional] | | **minSegments** | **Integer**| The minimum number of segments. | [optional] |
| **deviceId** | **String**| The device id of the client requesting. Used to stop encoding processes when needed. | [optional] | | **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&#39;s extension. Options: aac, mp3, vorbis, wma. | [optional] | | **audioCodec** | **String**| Optional. Specify an audio codec to encode to, e.g. mp3. | [optional] |
| **enableAutoStreamCopy** | **Boolean**| Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. | [optional] | | **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] | | **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] | | **allowAudioStreamCopy** | **Boolean**| Whether or not to allow copying of the audio stream url. | [optional] |
@ -1503,7 +1532,7 @@ public class Example {
| **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] | | **maxHeight** | **Integer**| Optional. The maximum vertical resolution of the encoded video. | [optional] |
| **videoBitRate** | **Integer**| Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. | [optional] | | **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] | | **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] | | **subtitleMethod** | **SubtitleDeliveryMethod**| Optional. Specify the subtitle delivery method. | [optional] [enum: Encode, Embed, External, Hls, Drop] |
| **maxRefFrames** | **Integer**| Optional. | [optional] | | **maxRefFrames** | **Integer**| Optional. | [optional] |
| **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] | | **maxVideoBitDepth** | **Integer**| Optional. The maximum video bit depth. | [optional] |
| **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] | | **requireAvc** | **Boolean**| Optional. Whether to require avc. | [optional] |
@ -1513,14 +1542,17 @@ public class Example {
| **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] | | **cpuCoreLimit** | **Integer**| Optional. The limit of how many cpu cores to use. | [optional] |
| **liveStreamId** | **String**| The live stream id. | [optional] | | **liveStreamId** | **String**| The live stream id. | [optional] |
| **enableMpegtsM2TsMode** | **Boolean**| Optional. Whether to enable the MpegtsM2Ts mode. | [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&#39;s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. | [optional] | | **videoCodec** | **String**| Optional. Specify a video codec to encode to, e.g. h264. | [optional] |
| **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] | | **subtitleCodec** | **String**| Optional. Specify a subtitle codec to encode to. | [optional] |
| **transcodeReasons** | **String**| Optional. The transcoding reason. | [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] | | **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] | | **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] | | **context** | **EncodingContext**| Optional. The MediaBrowser.Model.Dlna.EncodingContext. | [optional] [enum: Streaming, Static] |
| **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] | | **streamOptions** | [**Map&lt;String, String&gt;**](String.md)| Optional. The streaming options. | [optional] |
| **enableAdaptiveBitrateStreaming** | **Boolean**| Enable adaptive bitrate streaming. | [optional] [default to true] | | **enableAdaptiveBitrateStreaming** | **Boolean**| Enable adaptive bitrate streaming. | [optional] [default to true] |
| **enableTrickplay** | **Boolean**| Enable trickplay image playlists being added to master playlist. | [optional] [default to true] |
| **enableAudioVbrEncoding** | **Boolean**| Whether to enable Audio Encoding. | [optional] [default to true] |
| **alwaysBurnInSubtitleWhenTranscoding** | **Boolean**| Whether to always burn in subtitles when transcoding. | [optional] [default to false] |
### Return type ### Return type

View File

@ -0,0 +1,31 @@
# EncoderPreset
## Enum
* `AUTO` (value: `"auto"`)
* `PLACEBO` (value: `"placebo"`)
* `VERYSLOW` (value: `"veryslow"`)
* `SLOWER` (value: `"slower"`)
* `SLOW` (value: `"slow"`)
* `MEDIUM` (value: `"medium"`)
* `FAST` (value: `"fast"`)
* `FASTER` (value: `"faster"`)
* `VERYFAST` (value: `"veryfast"`)
* `SUPERFAST` (value: `"superfast"`)
* `ULTRAFAST` (value: `"ultrafast"`)

View File

@ -0,0 +1,60 @@
# EncodingOptions
Class EncodingOptions.
## Properties
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**encodingThreadCount** | **Integer** | Gets or sets the thread count used for encoding. | [optional] |
|**transcodingTempPath** | **String** | Gets or sets the temporary transcoding path. | [optional] |
|**fallbackFontPath** | **String** | Gets or sets the path to the fallback font. | [optional] |
|**enableFallbackFont** | **Boolean** | Gets or sets a value indicating whether to use the fallback font. | [optional] |
|**enableAudioVbr** | **Boolean** | Gets or sets a value indicating whether audio VBR is enabled. | [optional] |
|**downMixAudioBoost** | **Double** | Gets or sets the audio boost applied when downmixing audio. | [optional] |
|**downMixStereoAlgorithm** | **DownMixStereoAlgorithms** | Gets or sets the algorithm used for downmixing audio to stereo. | [optional] |
|**maxMuxingQueueSize** | **Integer** | Gets or sets the maximum size of the muxing queue. | [optional] |
|**enableThrottling** | **Boolean** | Gets or sets a value indicating whether throttling is enabled. | [optional] |
|**throttleDelaySeconds** | **Integer** | Gets or sets the delay after which throttling happens. | [optional] |
|**enableSegmentDeletion** | **Boolean** | Gets or sets a value indicating whether segment deletion is enabled. | [optional] |
|**segmentKeepSeconds** | **Integer** | Gets or sets seconds for which segments should be kept before being deleted. | [optional] |
|**hardwareAccelerationType** | **HardwareAccelerationType** | Gets or sets the hardware acceleration type. | [optional] |
|**encoderAppPath** | **String** | Gets or sets the FFmpeg path as set by the user via the UI. | [optional] |
|**encoderAppPathDisplay** | **String** | Gets or sets the current FFmpeg path being used by the system and displayed on the transcode page. | [optional] |
|**vaapiDevice** | **String** | Gets or sets the VA-API device. | [optional] |
|**qsvDevice** | **String** | Gets or sets the QSV device. | [optional] |
|**enableTonemapping** | **Boolean** | Gets or sets a value indicating whether tonemapping is enabled. | [optional] |
|**enableVppTonemapping** | **Boolean** | Gets or sets a value indicating whether VPP tonemapping is enabled. | [optional] |
|**enableVideoToolboxTonemapping** | **Boolean** | Gets or sets a value indicating whether videotoolbox tonemapping is enabled. | [optional] |
|**tonemappingAlgorithm** | **TonemappingAlgorithm** | Gets or sets the tone-mapping algorithm. | [optional] |
|**tonemappingMode** | **TonemappingMode** | Gets or sets the tone-mapping mode. | [optional] |
|**tonemappingRange** | **TonemappingRange** | Gets or sets the tone-mapping range. | [optional] |
|**tonemappingDesat** | **Double** | Gets or sets the tone-mapping desaturation. | [optional] |
|**tonemappingPeak** | **Double** | Gets or sets the tone-mapping peak. | [optional] |
|**tonemappingParam** | **Double** | Gets or sets the tone-mapping parameters. | [optional] |
|**vppTonemappingBrightness** | **Double** | Gets or sets the VPP tone-mapping brightness. | [optional] |
|**vppTonemappingContrast** | **Double** | Gets or sets the VPP tone-mapping contrast. | [optional] |
|**h264Crf** | **Integer** | Gets or sets the H264 CRF. | [optional] |
|**h265Crf** | **Integer** | Gets or sets the H265 CRF. | [optional] |
|**encoderPreset** | **EncoderPreset** | Gets or sets the encoder preset. | [optional] |
|**deinterlaceDoubleRate** | **Boolean** | Gets or sets a value indicating whether the framerate is doubled when deinterlacing. | [optional] |
|**deinterlaceMethod** | **DeinterlaceMethod** | Gets or sets the deinterlace method. | [optional] |
|**enableDecodingColorDepth10Hevc** | **Boolean** | Gets or sets a value indicating whether 10bit HEVC decoding is enabled. | [optional] |
|**enableDecodingColorDepth10Vp9** | **Boolean** | Gets or sets a value indicating whether 10bit VP9 decoding is enabled. | [optional] |
|**enableDecodingColorDepth10HevcRext** | **Boolean** | Gets or sets a value indicating whether 8/10bit HEVC RExt decoding is enabled. | [optional] |
|**enableDecodingColorDepth12HevcRext** | **Boolean** | Gets or sets a value indicating whether 12bit HEVC RExt decoding is enabled. | [optional] |
|**enableEnhancedNvdecDecoder** | **Boolean** | Gets or sets a value indicating whether the enhanced NVDEC is enabled. | [optional] |
|**preferSystemNativeHwDecoder** | **Boolean** | Gets or sets a value indicating whether the system native hardware decoder should be used. | [optional] |
|**enableIntelLowPowerH264HwEncoder** | **Boolean** | Gets or sets a value indicating whether the Intel H264 low-power hardware encoder should be used. | [optional] |
|**enableIntelLowPowerHevcHwEncoder** | **Boolean** | Gets or sets a value indicating whether the Intel HEVC low-power hardware encoder should be used. | [optional] |
|**enableHardwareEncoding** | **Boolean** | Gets or sets a value indicating whether hardware encoding is enabled. | [optional] |
|**allowHevcEncoding** | **Boolean** | Gets or sets a value indicating whether HEVC encoding is enabled. | [optional] |
|**allowAv1Encoding** | **Boolean** | Gets or sets a value indicating whether AV1 encoding is enabled. | [optional] |
|**enableSubtitleExtraction** | **Boolean** | Gets or sets a value indicating whether subtitle extraction is enabled. | [optional] |
|**hardwareDecodingCodecs** | **List&lt;String&gt;** | Gets or sets the codecs hardware encoding is used for. | [optional] |
|**allowOnDemandMetadataBasedKeyframeExtractionForExtensions** | **List&lt;String&gt;** | Gets or sets the file extensions on-demand metadata based keyframe extraction is enabled for. | [optional] |

View File

@ -1,6 +1,6 @@
# EnvironmentApi # EnvironmentApi
All URIs are relative to *http://nuc.ehrendingen:8096* All URIs are relative to *http://localhost*
| Method | HTTP request | Description | | Method | HTTP request | Description |
|------------- | ------------- | -------------| |------------- | ------------- | -------------|
@ -31,7 +31,7 @@ import org.openapitools.client.api.EnvironmentApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -96,7 +96,7 @@ import org.openapitools.client.api.EnvironmentApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -169,7 +169,7 @@ import org.openapitools.client.api.EnvironmentApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -234,7 +234,7 @@ import org.openapitools.client.api.EnvironmentApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -299,7 +299,7 @@ import org.openapitools.client.api.EnvironmentApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -368,7 +368,7 @@ import org.openapitools.client.api.EnvironmentApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");

View File

@ -0,0 +1,33 @@
# ExtraType
## Enum
* `UNKNOWN` (value: `"Unknown"`)
* `CLIP` (value: `"Clip"`)
* `TRAILER` (value: `"Trailer"`)
* `BEHIND_THE_SCENES` (value: `"BehindTheScenes"`)
* `DELETED_SCENE` (value: `"DeletedScene"`)
* `INTERVIEW` (value: `"Interview"`)
* `SCENE` (value: `"Scene"`)
* `SAMPLE` (value: `"Sample"`)
* `THEME_SONG` (value: `"ThemeSong"`)
* `THEME_VIDEO` (value: `"ThemeVideo"`)
* `FEATURETTE` (value: `"Featurette"`)
* `SHORT` (value: `"Short"`)

View File

@ -1,6 +1,6 @@
# FilterApi # FilterApi
All URIs are relative to *http://nuc.ehrendingen:8096* All URIs are relative to *http://localhost*
| Method | HTTP request | Description | | Method | HTTP request | Description |
|------------- | ------------- | -------------| |------------- | ------------- | -------------|
@ -27,7 +27,7 @@ import org.openapitools.client.api.FilterApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -114,7 +114,7 @@ import org.openapitools.client.api.FilterApi;
public class Example { public class Example {
public static void main(String[] args) { public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient(); ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://nuc.ehrendingen:8096"); defaultClient.setBasePath("http://localhost");
// Configure API key authorization: CustomAuthentication // Configure API key authorization: CustomAuthentication
ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication"); ApiKeyAuth CustomAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("CustomAuthentication");
@ -126,7 +126,7 @@ public class Example {
UUID userId = UUID.randomUUID(); // UUID | Optional. User id. UUID userId = UUID.randomUUID(); // UUID | Optional. User id.
UUID parentId = UUID.randomUUID(); // UUID | Optional. Parent id. UUID parentId = UUID.randomUUID(); // UUID | Optional. Parent id.
List<BaseItemKind> includeItemTypes = Arrays.asList(); // List<BaseItemKind> | Optional. If specified, results will be filtered 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<String> mediaTypes = Arrays.asList(); // List<String> | Optional. Filter by MediaType. Allows multiple, comma delimited. List<MediaType> mediaTypes = Arrays.asList(); // List<MediaType> | Optional. Filter by MediaType. Allows multiple, comma delimited.
try { try {
QueryFiltersLegacy result = apiInstance.getQueryFiltersLegacy(userId, parentId, includeItemTypes, mediaTypes); QueryFiltersLegacy result = apiInstance.getQueryFiltersLegacy(userId, parentId, includeItemTypes, mediaTypes);
System.out.println(result); System.out.println(result);
@ -148,7 +148,7 @@ public class Example {
| **userId** | **UUID**| Optional. User id. | [optional] | | **userId** | **UUID**| Optional. User id. | [optional] |
| **parentId** | **UUID**| Optional. Parent id. | [optional] | | **parentId** | **UUID**| Optional. Parent id. | [optional] |
| **includeItemTypes** | [**List&lt;BaseItemKind&gt;**](BaseItemKind.md)| Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. | [optional] | | **includeItemTypes** | [**List&lt;BaseItemKind&gt;**](BaseItemKind.md)| Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. | [optional] |
| **mediaTypes** | [**List&lt;String&gt;**](String.md)| Optional. Filter by MediaType. Allows multiple, comma delimited. | [optional] | | **mediaTypes** | [**List&lt;MediaType&gt;**](MediaType.md)| Optional. Filter by MediaType. Allows multiple, comma delimited. | [optional] |
### Return type ### Return type

View File

@ -0,0 +1,16 @@
# ForceKeepAliveMessage
Force keep alive websocket messages.
## Properties
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**data** | **Integer** | Gets or sets the data. | [optional] |
|**messageId** | **UUID** | Gets or sets the message id. | [optional] |
|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] |

View File

@ -0,0 +1,16 @@
# GeneralCommandMessage
General command websocket message.
## Properties
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**data** | [**GeneralCommand**](GeneralCommand.md) | Gets or sets the data. | [optional] |
|**messageId** | **UUID** | Gets or sets the message id. | [optional] |
|**messageType** | **SessionMessageType** | The different kinds of messages that are used in the WebSocket api. | [optional] [readonly] |

View File

@ -89,5 +89,7 @@
* `SET_MAX_STREAMING_BITRATE` (value: `"SetMaxStreamingBitrate"`) * `SET_MAX_STREAMING_BITRATE` (value: `"SetMaxStreamingBitrate"`)
* `SET_PLAYBACK_ORDER` (value: `"SetPlaybackOrder"`)

Some files were not shown because too many files have changed in this diff Show More